diff options
Diffstat (limited to 'docs/api/html/nmcli.html')
| -rw-r--r-- | docs/api/html/nmcli.html | 166 |
1 files changed, 84 insertions, 82 deletions
diff --git a/docs/api/html/nmcli.html b/docs/api/html/nmcli.html index 4014c714..bcef8464 100644 --- a/docs/api/html/nmcli.html +++ b/docs/api/html/nmcli.html @@ -39,7 +39,9 @@ replacement for <span class="command"><strong>nm-applet</strong></span> or other graphical clients. <span class="command"><strong>nmcli</strong></span> is used to create, display, edit, delete, activate, and deactivate network connections, as well as control and display network - device status.</p> + device status. See + <a class="link" href="nmcli-examples.html" title="nmcli-examples"><span class="citerefentry"><span class="refentrytitle">nmcli-examples</span>(7)</span></a> + for ready to run nmcli examples.</p> <p>Typical uses include:</p> <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> <li class="listitem"><p>Scripts: Utilize NetworkManager via <span class="command"><strong>nmcli</strong></span> instead of @@ -63,47 +65,11 @@ </colgroup> <tbody> <tr> -<td><p><span class="term"> <code class="option">-t</code> | <code class="option">--terse</code> </span></p></td> -<td><p>Output is terse. This mode is designed and suitable for computer (script) - processing.</p></td> -</tr> -<tr> -<td><p><span class="term"> <code class="option">-p</code> | <code class="option">--pretty</code> </span></p></td> -<td><p>Output is pretty. This causes <span class="command"><strong>nmcli</strong></span> to produce easily - readable outputs for humans, i.e. values are aligned, headers are printed, - etc.</p></td> -</tr> -<tr> -<td><p><span class="term"> <code class="option">-m</code> | <code class="option">--mode</code> { tabular | multiline } </span></p></td> -<td> -<p>Switch between tabular and multiline output:</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"> tabular </span></p></td> -<td><p>Output is a table where each line describes a single entry. - Columns define particular properties of the entry.</p></td> -</tr> -<tr> -<td><p><span class="term"> multiline </span></p></td> -<td><p>Each entry comprises multiple lines, each property on its - own line. The values are prefixed with the property name.</p></td> -</tr> -</tbody> -</table></div> -<p>If omitted, default is <code class="literal">tabular</code> for most commands. - For the commands producing more structured information, that cannot be - displayed on a single line, default is <code class="literal">multiline</code>. - Currently, they are:</p> -<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> -<li class="listitem"><p><code class="literal">nmcli connection show <em class="replaceable"><code>ID</code></em></code></p></li> -<li class="listitem"><p><code class="literal">nmcli device show</code></p></li> -</ul></div> -</td> +<td><p><span class="term"> <code class="option">-a</code> | <code class="option">--ask</code> </span></p></td> +<td><p>When using this option <span class="command"><strong>nmcli</strong></span> will stop and ask for any + missing required arguments, so do not use this option for non-interactive + purposes like scripts. This option controls, for example, whether you will be + prompted for a password if it is required for connecting to a network.</p></td> </tr> <tr> <td><p><span class="term"> <code class="option">-c</code> | <code class="option">--colors</code> { yes | no | auto } </span></p></td> @@ -119,6 +85,25 @@ </td> </tr> <tr> +<td><p><span class="term"> <code class="option">--complete-args</code> </span></p></td> +<td> +<p>Instead of conducting the desired action, <span class="command"><strong>nmcli</strong></span> + will list possible completions for the last argument. This is useful to implement + argument completion in shell.</p> +<p>The <a class="link" href="nmcli.html#exit_status" title="Exit Status">exit status</a> will indicate success + or return a code 65 to indicate the last argument is a file name.</p> +<p>NetworkManager ships with command completion support for GNU Bash.</p> +</td> +</tr> +<tr> +<td><p><span class="term"> <code class="option">-e</code> | <code class="option">--escape</code> { yes | no } </span></p></td> +<td> +<p>Whether to escape <code class="literal">:</code> and <code class="literal">\</code> characters in terse tabular mode. The + escape character is <code class="literal">\</code>.</p> +<p>If omitted, default is <code class="literal">yes</code>.</p> +</td> +</tr> +<tr> <td><p><span class="term"> <code class="option">-f</code> | <code class="option">--fields</code> { <em class="replaceable"><code>field1</code></em>,<em class="replaceable"><code>field2</code></em>... | all | common } </span></p></td> <td> <p>This option is used to specify what fields (column names) should be @@ -143,19 +128,46 @@ </td> </tr> <tr> -<td><p><span class="term"> <code class="option">-e</code> | <code class="option">--escape</code> { yes | no } </span></p></td> +<td><p><span class="term"> <code class="option">-h</code> | <code class="option">--help</code> </span></p></td> +<td><p>Print help information.</p></td> +</tr> +<tr> +<td><p><span class="term"> <code class="option">-m</code> | <code class="option">--mode</code> { tabular | multiline } </span></p></td> <td> -<p>Whether to escape <code class="literal">:</code> and <code class="literal">\</code> characters in terse tabular mode. The - escape character is <code class="literal">\</code>.</p> -<p>If omitted, default is <code class="literal">yes</code>.</p> +<p>Switch between tabular and multiline output:</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"> tabular </span></p></td> +<td><p>Output is a table where each line describes a single entry. + Columns define particular properties of the entry.</p></td> +</tr> +<tr> +<td><p><span class="term"> multiline </span></p></td> +<td><p>Each entry comprises multiple lines, each property on its + own line. The values are prefixed with the property name.</p></td> +</tr> +</tbody> +</table></div> +<p>If omitted, default is <code class="literal">tabular</code> for most commands. + For the commands producing more structured information, that cannot be + displayed on a single line, default is <code class="literal">multiline</code>. + Currently, they are:</p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="literal">nmcli connection show <em class="replaceable"><code>ID</code></em></code></p></li> +<li class="listitem"><p><code class="literal">nmcli device show</code></p></li> +</ul></div> </td> </tr> <tr> -<td><p><span class="term"> <code class="option">-a</code> | <code class="option">--ask</code> </span></p></td> -<td><p>When using this option <span class="command"><strong>nmcli</strong></span> will stop and ask for any - missing required arguments, so do not use this option for non-interactive - purposes like scripts. This option controls, for example, whether you will be - prompted for a password if it is required for connecting to a network.</p></td> +<td><p><span class="term"> <code class="option">-p</code> | <code class="option">--pretty</code> </span></p></td> +<td><p>Output is pretty. This causes <span class="command"><strong>nmcli</strong></span> to produce easily + readable outputs for humans, i.e. values are aligned, headers are printed, + etc.</p></td> </tr> <tr> <td><p><span class="term"> <code class="option">-s</code> | <code class="option">--show-secrets</code> </span></p></td> @@ -164,6 +176,15 @@ also influences echoing passwords typed by user as an input.</p></td> </tr> <tr> +<td><p><span class="term"> <code class="option">-t</code> | <code class="option">--terse</code> </span></p></td> +<td><p>Output is terse. This mode is designed and suitable for computer (script) + processing.</p></td> +</tr> +<tr> +<td><p><span class="term"> <code class="option">-v</code> | <code class="option">--version</code> </span></p></td> +<td><p>Show <span class="command"><strong>nmcli</strong></span> version.</p></td> +</tr> +<tr> <td><p><span class="term"> <code class="option">-w</code> | <code class="option">--wait</code> <em class="replaceable"><code>seconds</code></em> </span></p></td> @@ -177,25 +198,6 @@ success. The default value depends on the executed command.</p> </td> </tr> -<tr> -<td><p><span class="term"> <code class="option">--complete-args</code> </span></p></td> -<td> -<p>Instead of conducting the desired action, <span class="command"><strong>nmcli</strong></span> - will list possible completions for the last argument. This is useful to implement - argument completion in shell.</p> -<p>The <a class="link" href="nmcli.html#exit_status" title="Exit Status">exit status</a> will indicate success - or return a code 65 to indicate the last argument is a file name.</p> -<p>NetworkManager ships with command completion support for GNU Bash.</p> -</td> -</tr> -<tr> -<td><p><span class="term"> <code class="option">-v</code> | <code class="option">--version</code> </span></p></td> -<td><p>Show <span class="command"><strong>nmcli</strong></span> version.</p></td> -</tr> -<tr> -<td><p><span class="term"> <code class="option">-h</code> | <code class="option">--help</code> </span></p></td> -<td><p>Print help information.</p></td> -</tr> </tbody> </table></div> </div> @@ -572,9 +574,10 @@ <p>Be aware that this command deactivates the specified active connection, but the device on which the connection was active, is still ready to connect and will perform auto-activation by looking for a suitable connection that has - the 'autoconnect' flag set. This includes the just deactivated connection. So - if the connection is set to auto-connect, it will be automatically started on - the disconnected device again.</p> + the 'autoconnect' flag set. Note that the deactivating connection profile is + internally blocked from autoconnecting again. Hence it will not autoconnect + until reboot or until the user performs an action that unblocks autoconnect, + like modifying the profile or explicitly activating it.</p> <p>In most cases you may want to use <span class="command"><strong>device disconnect</strong></span> command instead.</p> <p>The connection is identified by its name, UUID or D-Bus path. If @@ -1024,14 +1027,13 @@ </span></p></td> <td> <p>Connect to a Wi-Fi network specified by SSID or BSSID. The command - creates a new connection and then activates it on a device. This is a - command-line counterpart of clicking an SSID in a GUI client. The command - always creates a new connection and thus it is mainly useful for connecting to - new Wi-Fi networks. If a connection for the network already exists, it is - better to bring up (activate) the existing connection as follows: + finds a matching connection or creates one and then activates it on a device. + This is a command-line counterpart of clicking an SSID in a GUI client. If + a connection for the network already exists, it is possible to bring up + (activate) the existing profile as follows: <span class="command"><strong>nmcli con up id <em class="replaceable"><code>name</code></em></strong></span>. Note that - only open, WEP and WPA-PSK networks are supported at the moment. It is also - supposed that IP configuration is obtained via DHCP.</p> + only open, WEP and WPA-PSK networks are supported if no previous connection + exists. It is also assumed that IP configuration is obtained via DHCP.</p> <p>If <code class="option">--wait</code> option is not specified, the default timeout will be 90 seconds.</p> <p>Available options are:</p> @@ -2386,8 +2388,8 @@ It's equivalent to the <code class="literal">+bond.options 'option=value'</code> <td><p>shows details for "My default em1" connection profile.</p></td> </tr> <tr> -<td><p><span class="term"><strong class="userinput"><code>nmcli --show-secrets connection show "My Home WiFi"</code></strong></span></p></td> -<td><p>shows details for "My Home WiFi" connection profile with all passwords. +<td><p><span class="term"><strong class="userinput"><code>nmcli --show-secrets connection show "My Home Wi-Fi"</code></strong></span></p></td> +<td><p>shows details for "My Home Wi-Fi" connection profile with all passwords. Without <code class="option">--show-secrets</code> option, secrets would not be displayed.</p></td> </tr> |