diff options
| author | Michael Biebl <biebl@debian.org> | 2016-04-12 17:33:05 +0200 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2016-04-12 17:33:05 +0200 |
| commit | 288a08a3672a89a9bfdb8354b6863cc039759fc2 (patch) | |
| tree | 351ac159de25507ba7eeab003153dabb1c6652a2 /docs/api/html/nmcli-examples.html | |
| parent | 2bfb3eb7d0323e69affca154395f51d8b577414d (diff) | |
Imported Upstream version 1.1.94 upstream/1.1.94
Diffstat (limited to 'docs/api/html/nmcli-examples.html')
| -rw-r--r-- | docs/api/html/nmcli-examples.html | 119 |
1 files changed, 59 insertions, 60 deletions
diff --git a/docs/api/html/nmcli-examples.html b/docs/api/html/nmcli-examples.html index e903cd68..3e9d0b52 100644 --- a/docs/api/html/nmcli-examples.html +++ b/docs/api/html/nmcli-examples.html @@ -2,12 +2,12 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>nmcli-examples: NetworkManager D-Bus API Reference Manual</title> +<title>nmcli-examples: NetworkManager Reference Manual</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> -<link rel="home" href="index.html" title="NetworkManager D-Bus API Reference Manual"> -<link rel="up" href="manpages.html" title="UNIX Manual Pages"> -<link rel="prev" href="NetworkManager.conf.html" title="NetworkManager.conf"> -<link rel="next" href="nm-settings.html" title="nm-settings"> +<link rel="home" href="index.html" title="NetworkManager Reference Manual"> +<link rel="up" href="manpages.html" title="Manual Pages"> +<link rel="prev" href="nm-settings-ifcfg-rh.html" title="nm-settings-ifcfg-rh"> +<link rel="next" href="NetworkManager.html" title="NetworkManager"> <meta name="generator" content="GTK-Doc V1.24 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> @@ -16,8 +16,8 @@ <td width="100%" align="left" class="shortcuts"></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> <td><a accesskey="u" href="manpages.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="NetworkManager.conf.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="nm-settings.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +<td><a accesskey="p" href="nm-settings-ifcfg-rh.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="NetworkManager.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="refentry"> <a name="nmcli-examples"></a><div class="titlepage"></div> @@ -30,10 +30,10 @@ </tr></table></div> <div class="refsynopsisdiv"> <h2>Synopsis</h2> -<div class="cmdsynopsis"><p><code class="command">nmcli [OPTIONS...]</code> </p></div> +<div class="cmdsynopsis"><p><code class="command">nmcli</code> [OPTIONS...]</p></div> </div> <div class="refsect1"> -<a name="id-1.4.7.5"></a><h2>Description</h2> +<a name="id-1.2.9.5"></a><h2>Description</h2> <p> <span class="emphasis"><em>nmcli</em></span> is a command-line client for NetworkManager. It allows controlling NetworkManager and reporting its status. For more information @@ -44,14 +44,13 @@ The purpose of this manual page is to provide you with various examples and usage scenarios of <span class="emphasis"><em>nmcli</em></span>. </p> -<p>Note: this page has "work-in-progress" status.</p> </div> <div class="refsect1"> -<a name="id-1.4.7.6"></a><h2>Examples</h2> +<a name="id-1.2.9.6"></a><h2>Examples</h2> <div class="example"> -<a name="id-1.4.7.6.2"></a><p class="title"><b>Example 1. Listing available Wi-Fi APs</b></p> +<a name="id-1.2.9.6.2"></a><p class="title"><b>Example 1. Listing available Wi-Fi APs</b></p> <div class="example-contents"> -<pre class="screen"><strong class="userinput"><code>$ nmcli device wifi list</code></strong> +<pre class="screen"><code class="prompt">$ </code><strong class="userinput"><code>nmcli device wifi list</code></strong> * SSID MODE CHAN RATE SIGNAL BARS SECURITY netdatacomm_local Infra 6 54 Mbit/s 37 ▂▄__ WEP * F1 Infra 11 54 Mbit/s 98 ▂▄▆█ WPA1 @@ -72,9 +71,9 @@ </div> </div> <br class="example-break"><div class="example"> -<a name="id-1.4.7.6.3"></a><p class="title"><b>Example 2. Showing general information and properties for a Wi-Fi interface</b></p> +<a name="id-1.2.9.6.3"></a><p class="title"><b>Example 2. Showing general information and properties for a Wi-Fi interface</b></p> <div class="example-contents"> -<pre class="screen"><strong class="userinput"><code>$ nmcli -p -f general,wifi-properties device show wlan0</code></strong> +<pre class="screen"><code class="prompt">$ </code><strong class="userinput"><code>nmcli -p -f general,wifi-properties device show wlan0</code></strong> =========================================================================== Device details (wlan0) =========================================================================== @@ -114,9 +113,9 @@ WIFI-PROPERTIES.ADHOC: yes </div> </div> <br class="example-break"><div class="example"> -<a name="id-1.4.7.6.4"></a><p class="title"><b>Example 3. Listing NetworkManager polkit permissions</b></p> +<a name="id-1.2.9.6.4"></a><p class="title"><b>Example 3. Listing NetworkManager polkit permissions</b></p> <div class="example-contents"> -<pre class="screen"><strong class="userinput"><code>$ nmcli general permissions</code></strong> +<pre class="screen"><code class="prompt">$ </code><strong class="userinput"><code>nmcli general permissions</code></strong> PERMISSION VALUE org.freedesktop.NetworkManager.enable-disable-network yes org.freedesktop.NetworkManager.enable-disable-wifi yes @@ -145,9 +144,9 @@ org.freedesktop.NetworkManager.settings.modify.hostname auth</pre> </div> </div> <br class="example-break"><div class="example"> -<a name="id-1.4.7.6.5"></a><p class="title"><b>Example 4. Listing NetworkManager log level and domains</b></p> +<a name="id-1.2.9.6.5"></a><p class="title"><b>Example 4. Listing NetworkManager log level and domains</b></p> <div class="example-contents"> -<pre class="screen"><strong class="userinput"><code>$ nmcli general logging</code></strong> +<pre class="screen"><code class="prompt">$ </code><strong class="userinput"><code>nmcli general logging</code></strong> LEVEL DOMAINS INFO PLATFORM,RFKILL,ETHER,WIFI,BT,MB,DHCP4,DHCP6,PPP,WIFI_SCAN,IP4,IP6,A UTOIP4,DNS,VPN,SHARING,SUPPLICANT,AGENTS,SETTINGS,SUSPEND,CORE,DEVICE,OLPC, @@ -159,10 +158,10 @@ B,DISPATCH</pre> </div> </div> <br class="example-break"><div class="example"> -<a name="id-1.4.7.6.6"></a><p class="title"><b>Example 5. Changing NetworkManager logging</b></p> +<a name="id-1.2.9.6.6"></a><p class="title"><b>Example 5. Changing NetworkManager logging</b></p> <div class="example-contents"> -<pre class="screen"><strong class="userinput"><code>$ nmcli g log level DEBUG domains CORE,ETHER,IP</code></strong> -<strong class="userinput"><code>$ nmcli g log level INFO domains DEFAULT</code></strong></pre> +<pre class="screen"><code class="prompt">$ </code><strong class="userinput"><code>nmcli g log level DEBUG domains CORE,ETHER,IP</code></strong> +<code class="prompt">$ </code><strong class="userinput"><code>nmcli g log level INFO domains DEFAULT</code></strong></pre> <p> The first command makes NetworkManager log in DEBUG level, and only for CORE, ETHER and IP domains. The second command restores the default logging state. Please refer to the @@ -172,11 +171,11 @@ B,DISPATCH</pre> </div> </div> <br class="example-break"><div class="example"> -<a name="id-1.4.7.6.7"></a><p class="title"><b>Example 6. Adding a bonding master and two slave connection profiles</b></p> +<a name="id-1.2.9.6.7"></a><p class="title"><b>Example 6. Adding a bonding master and two slave connection profiles</b></p> <div class="example-contents"> -<pre class="screen"><strong class="userinput"><code>$ nmcli con add type bond ifname mybond0 mode active-backup</code></strong> -<strong class="userinput"><code>$ nmcli con add type ethernet ifname eth1 master mybond0</code></strong> -<strong class="userinput"><code>$ nmcli con add type ethernet ifname eth2 master mybond0</code></strong></pre> +<pre class="screen"><code class="prompt">$ </code><strong class="userinput"><code>nmcli con add type bond ifname mybond0 mode active-backup</code></strong> +<code class="prompt">$ </code><strong class="userinput"><code>nmcli con add type ethernet ifname eth1 master mybond0</code></strong> +<code class="prompt">$ </code><strong class="userinput"><code>nmcli con add type ethernet ifname eth2 master mybond0</code></strong></pre> <p> This example demonstrates adding a bond master connection and two slaves. The first command adds a master bond connection, naming the bonding interface @@ -188,11 +187,11 @@ B,DISPATCH</pre> </div> </div> <br class="example-break"><div class="example"> -<a name="id-1.4.7.6.8"></a><p class="title"><b>Example 7. Adding a team master and two slave connection profiles</b></p> +<a name="id-1.2.9.6.8"></a><p class="title"><b>Example 7. Adding a team master and two slave connection profiles</b></p> <div class="example-contents"> -<pre class="screen"><strong class="userinput"><code>$ nmcli con add type team con-name Team1 ifname Team1 config team1-master-json.conf</code></strong> -<strong class="userinput"><code>$ nmcli con add type ethernet con-name Team1-slave1 ifname em1 master Team1</code></strong> -<strong class="userinput"><code>$ nmcli con add type ethernet con-name Team1-slave2 ifname em2 master Team1</code></strong></pre> +<pre class="screen"><code class="prompt">$ </code><strong class="userinput"><code>nmcli con add type team con-name Team1 ifname Team1 config team1-master-json.conf</code></strong> +<code class="prompt">$ </code><strong class="userinput"><code>nmcli con add type ethernet con-name Team1-slave1 ifname em1 master Team1</code></strong> +<code class="prompt">$ </code><strong class="userinput"><code>nmcli con add type ethernet con-name Team1-slave2 ifname em2 master Team1</code></strong></pre> <p> This example demonstrates adding a team master connection profile and two slaves. It is very similar to the bonding example. The first command adds a master team profile, naming @@ -206,8 +205,8 @@ B,DISPATCH</pre> <span class="emphasis"><em>teamd</em></span> will use its default configuration. You will activate the whole setup by activating both slaves: </p> -<pre class="screen"> <strong class="userinput"><code>$ nmcli con up Team1-slave1</code></strong> - <strong class="userinput"><code>$ nmcli con up Team1-slave2</code></strong></pre> +<pre class="screen"> <code class="prompt">$ </code><strong class="userinput"><code>nmcli con up Team1-slave1</code></strong> + <code class="prompt">$ </code><strong class="userinput"><code>nmcli con up Team1-slave2</code></strong></pre> <p> By default, the created profiles are marked for auto-activation. But if another connection has been activated on the device, the new profile won't activate @@ -216,12 +215,12 @@ B,DISPATCH</pre> </div> </div> <br class="example-break"><div class="example"> -<a name="id-1.4.7.6.9"></a><p class="title"><b>Example 8. Adding a bridge and two slave profiles</b></p> +<a name="id-1.2.9.6.9"></a><p class="title"><b>Example 8. Adding a bridge and two slave profiles</b></p> <div class="example-contents"> -<pre class="screen"><strong class="userinput"><code>$ nmcli con add type bridge con-name TowerBridge ifname TowerBridge</code></strong> -<strong class="userinput"><code>$ nmcli con add type ethernet con-name br-slave-1 ifname ens3 master TowerBridge</code></strong> -<strong class="userinput"><code>$ nmcli con add type ethernet con-name br-slave-2 ifname ens4 master TowerBridge</code></strong> -<strong class="userinput"><code>$ nmcli con modify TowerBridge bridge.stp no</code></strong></pre> +<pre class="screen"><code class="prompt">$ </code><strong class="userinput"><code>nmcli con add type bridge con-name TowerBridge ifname TowerBridge</code></strong> +<code class="prompt">$ </code><strong class="userinput"><code>nmcli con add type ethernet con-name br-slave-1 ifname ens3 master TowerBridge</code></strong> +<code class="prompt">$ </code><strong class="userinput"><code>nmcli con add type ethernet con-name br-slave-2 ifname ens4 master TowerBridge</code></strong> +<code class="prompt">$ </code><strong class="userinput"><code>nmcli con modify TowerBridge bridge.stp no</code></strong></pre> <p> This example demonstrates adding a bridge master connection and two slaves. The first command adds a master bridge connection, naming the bridge interface and @@ -235,14 +234,14 @@ B,DISPATCH</pre> </div> </div> <br class="example-break"><div class="example"> -<a name="id-1.4.7.6.10"></a><p class="title"><b>Example 9. Adding an ethernet connection profile with manual IP configuration</b></p> +<a name="id-1.2.9.6.10"></a><p class="title"><b>Example 9. Adding an ethernet connection profile with manual IP configuration</b></p> <div class="example-contents"> -<pre class="screen"><strong class="userinput"><code>$ nmcli con add con-name my-con-em1 ifname em1 type ethernet \ +<pre class="screen"><code class="prompt">$ </code><strong class="userinput"><code>nmcli con add con-name my-con-em1 ifname em1 type ethernet \ ip4 192.168.100.100/24 gw4 192.168.100.1 ip4 1.2.3.4 ip6 abbe::cafe</code></strong> -<strong class="userinput"><code>$ nmcli con mod my-con-em1 ipv4.dns "8.8.8.8 8.8.4.4"</code></strong> -<strong class="userinput"><code>$ nmcli con mod my-con-em1 +ipv4.dns 1.2.3.4</code></strong> -<strong class="userinput"><code>$ nmcli con mod my-con-em1 ipv6.dns "2001:4860:4860::8888 2001:4860:4860::8844"</code></strong> -<strong class="userinput"><code>$ nmcli -p con show my-con-em1</code></strong></pre> +<code class="prompt">$ </code><strong class="userinput"><code>nmcli con mod my-con-em1 ipv4.dns "8.8.8.8 8.8.4.4"</code></strong> +<code class="prompt">$ </code><strong class="userinput"><code>nmcli con mod my-con-em1 +ipv4.dns 1.2.3.4</code></strong> +<code class="prompt">$ </code><strong class="userinput"><code>nmcli con mod my-con-em1 ipv6.dns "2001:4860:4860::8888 2001:4860:4860::8844"</code></strong> +<code class="prompt">$ </code><strong class="userinput"><code>nmcli -p con show my-con-em1</code></strong></pre> <p> The first command adds an Ethernet connection profile named <span class="emphasis"><em>my-con-em1</em></span> that is bound to interface name <span class="emphasis"><em>em1</em></span>. The profile is configured @@ -258,9 +257,9 @@ B,DISPATCH</pre> </div> </div> <br class="example-break"><div class="example"> -<a name="id-1.4.7.6.11"></a><p class="title"><b>Example 10. Escaping colon characters in tabular mode</b></p> +<a name="id-1.2.9.6.11"></a><p class="title"><b>Example 10. Escaping colon characters in tabular mode</b></p> <div class="example-contents"> -<pre class="screen"><strong class="userinput"><code>$ nmcli -t -f general -e yes -m tab dev show eth0</code></strong> +<pre class="screen"><code class="prompt">$ </code><strong class="userinput"><code>nmcli -t -f general -e yes -m tab dev show eth0</code></strong> GENERAL:eth0:ethernet:Intel Corporation:82567LM Gigabit Network Connection: e1000e:2.1.4-k:1.8-3:00\:22\:68\:15\:29\:21:1500:100 (connected):0 (No reas on given):/sys/devices/pci0000\:00/0000\:00\:19.0/net/eth0:eth0:yes:yes:no: @@ -273,7 +272,7 @@ nager/ActiveConnection/9</pre> </div> </div> <br class="example-break"><div class="example"> -<a name="id-1.4.7.6.12"></a><p class="title"><b>Example 11. nmcli usage in a NetworkManager dispatcher script to make Ethernet and Wi-Fi mutually exclusive</b></p> +<a name="id-1.2.9.6.12"></a><p class="title"><b>Example 11. nmcli usage in a NetworkManager dispatcher script to make Ethernet and Wi-Fi mutually exclusive</b></p> <div class="example-contents"> <pre class="programlisting"> #!/bin/bash @@ -311,9 +310,9 @@ fi </div> <br class="example-break"><p><span class="bold"><strong>Example sessions of interactive connection editor</strong></span></p> <div class="example"> -<a name="id-1.4.7.6.14"></a><p class="title"><b>Example 12. Adding an ethernet connection profile in interactive editor (a)</b></p> +<a name="id-1.2.9.6.14"></a><p class="title"><b>Example 12. Adding an ethernet connection profile in interactive editor (a)</b></p> <div class="example-contents"> -<pre class="screen"><strong class="userinput"><code>$ nmcli connection edit type ethernet</code></strong> +<pre class="screen"><code class="prompt">$ </code><strong class="userinput"><code>nmcli connection edit type ethernet</code></strong> ===| nmcli interactive connection editor |=== @@ -324,7 +323,7 @@ Type 'describe [<setting>.<prop>]' for detailed property description You may edit the following settings: connection, 802-3-ethernet (ethernet), 802-1x, ipv4, ipv6, dcb -nmcli> <strong class="userinput"><code>print</code></strong> +<code class="prompt">nmcli> </code><strong class="userinput"><code>print</code></strong> =========================================================================== Connection details =========================================================================== @@ -384,13 +383,13 @@ ipv6.may-fail: yes ipv6.ip6-privacy: -1 (unknown) ipv6.dhcp-hostname: -- --------------------------------------------------------------------------- -nmcli> <strong class="userinput"><code>goto ethernet</code></strong> +<code class="prompt">nmcli> </code><strong class="userinput"><code>goto ethernet</code></strong> You may edit the following properties: port, speed, duplex, auto-negotiate, mac-address, cloned-mac-address, mac-address-blacklist, mtu, s390-subchann els, s390-nettype, s390-options nmcli 802-3-ethernet> set mtu 1492 nmcli 802-3-ethernet> b -nmcli> <strong class="userinput"><code>goto ipv4.addresses</code></strong> +<code class="prompt">nmcli> </code><strong class="userinput"><code>goto ipv4.addresses</code></strong> nmcli ipv4.addresses> desc === [addresses] === @@ -411,10 +410,10 @@ nmcli ipv4.addresses> print addresses: 192.168.1.100/24 nmcli ipv4.addresses> back nmcli ipv4> b -nmcli> <strong class="userinput"><code>set ipv4.gateway 192.168.1.1</code></strong> -nmcli> <strong class="userinput"><code>verify</code></strong> +<code class="prompt">nmcli> </code><strong class="userinput"><code>set ipv4.gateway 192.168.1.1</code></strong> +<code class="prompt">nmcli> </code><strong class="userinput"><code>verify</code></strong> Verify connection: OK -nmcli> <strong class="userinput"><code>print</code></strong> +<code class="prompt">nmcli> </code><strong class="userinput"><code>print</code></strong> =========================================================================== Connection details =========================================================================== @@ -473,8 +472,8 @@ ipv6.may-fail: yes ipv6.ip6-privacy: -1 (unknown) ipv6.dhcp-hostname: -- --------------------------------------------------------------------------- -nmcli> <strong class="userinput"><code>set ipv4.dns 8.8.8.8 8.8.4.4</code></strong> -nmcli> <strong class="userinput"><code>print</code></strong> +<code class="prompt">nmcli> </code><strong class="userinput"><code>set ipv4.dns 8.8.8.8 8.8.4.4</code></strong> +<code class="prompt">nmcli> </code><strong class="userinput"><code>print</code></strong> =========================================================================== Connection details =========================================================================== @@ -534,12 +533,12 @@ ipv6.may-fail: yes ipv6.ip6-privacy: -1 (unknown) ipv6.dhcp-hostname: -- --------------------------------------------------------------------------- -nmcli> <strong class="userinput"><code>verify</code></strong> +<code class="prompt">nmcli> </code><strong class="userinput"><code>verify</code></strong> Verify connection: OK -nmcli> <strong class="userinput"><code>save</code></strong> +<code class="prompt">nmcli> </code><strong class="userinput"><code>save</code></strong> Connection 'ethernet-4' (de89cdeb-a3e1-4d53-8fa0-c22546c775f4) successfully saved. -nmcli> <strong class="userinput"><code>quit</code></strong></pre> +<code class="prompt">nmcli> </code><strong class="userinput"><code>quit</code></strong></pre> <p> Example session in the nmcli interactive connection editor. The scenario creates an Ethernet connection profile with static addressing (IPs and DNS). @@ -549,7 +548,7 @@ nmcli> <strong class="userinput"><code>quit</code></strong></pre> <br class="example-break"> </div> <div class="refsect1"> -<a name="id-1.4.7.7"></a><h2>See Also</h2> +<a name="id-1.2.9.7"></a><h2>See Also</h2> <p> <span class="citerefentry"><span class="refentrytitle">nmcli</span>(1)</span>, <span class="citerefentry"><span class="refentrytitle">NetworkManager</span>(8)</span>, |