diff options
author | Lubomir Rintel <lkundrak@v3.sk> | 2016-04-01 12:19:09 +0200 |
---|---|---|
committer | Lubomir Rintel <lkundrak@v3.sk> | 2016-04-01 12:29:20 +0200 |
commit | 159c95cbe2b0f2027e794a2565395ae7add32e77 (patch) | |
tree | f5b4a7b994656ca60b25340862906bf0048a68b7 /man/nmcli-examples.xml | |
parent | f446afbfada5251f6d59e7161a1f096e798eba4e (diff) | |
download | NetworkManager-159c95cbe2b0f2027e794a2565395ae7add32e77.tar.gz |
man/nmcli-examples: no extra breaks around listings
Looks bad in HTML.
Diffstat (limited to 'man/nmcli-examples.xml')
-rw-r--r-- | man/nmcli-examples.xml | 257 |
1 files changed, 116 insertions, 141 deletions
diff --git a/man/nmcli-examples.xml b/man/nmcli-examples.xml index 0e123ff764..e9c6925b2a 100644 --- a/man/nmcli-examples.xml +++ b/man/nmcli-examples.xml @@ -51,8 +51,7 @@ Copyright 2013 - 2014 Red Hat, Inc. <title>Examples</title> <example><title>Listing available Wi-Fi APs</title> - <screen> -<userinput>$ nmcli device wifi list</userinput> +<screen><userinput>$ nmcli device wifi list</userinput> * SSID MODE CHAN RATE SIGNAL BARS SECURITY netdatacomm_local Infra 6 54 Mbit/s 37 ▂▄__ WEP * F1 Infra 11 54 Mbit/s 98 ▂▄▆█ WPA1 @@ -64,18 +63,16 @@ Copyright 2013 - 2014 Red Hat, Inc. MARTINA Infra 4 54 Mbit/s 32 ▂▄__ WPA2 N24PU1 Infra 7 11 Mbit/s 22 ▂___ -- alfa Infra 1 54 Mbit/s 67 ▂▄▆_ WPA2 - bertnet Infra 5 54 Mbit/s 20 ▂___ WPA1 WPA2 - </screen> + bertnet Infra 5 54 Mbit/s 20 ▂___ WPA1 WPA2</screen> + <para> + This command shows how to list available Wi-Fi networks (APs). You can also use + <emphasis>--fields</emphasis> option for displaying different columns. + <emphasis role="bold">nmcli -f all dev wifi list</emphasis> will show all of them. + </para> </example> - <para> - This command shows how to list available Wi-Fi networks (APs). You can also use - <emphasis>--fields</emphasis> option for displaying different columns. - <emphasis role="bold">nmcli -f all dev wifi list</emphasis> will show all of them. - </para> <example><title>Showing general information and properties for a Wi-Fi interface</title> - <screen> -<userinput>$ nmcli -p -f general,wifi-properties device show wlan0</userinput> +<screen><userinput>$ nmcli -p -f general,wifi-properties device show wlan0</userinput> =========================================================================== Device details (wlan0) =========================================================================== @@ -108,16 +105,14 @@ WIFI-PROPERTIES.TKIP: yes WIFI-PROPERTIES.CCMP: yes WIFI-PROPERTIES.AP: no WIFI-PROPERTIES.ADHOC: yes ---------------------------------------------------------------------------- - </screen> +---------------------------------------------------------------------------</screen> + <para> + This command shows information about a Wi-Fi device. + </para> </example> - <para> - This command shows information about a Wi-Fi device. - </para> <example><title>Listing NetworkManager polkit permissions</title> - <screen> -<userinput>$ nmcli general permissions</userinput> +<screen><userinput>$ nmcli general permissions</userinput> PERMISSION VALUE org.freedesktop.NetworkManager.enable-disable-network yes org.freedesktop.NetworkManager.enable-disable-wifi yes @@ -129,148 +124,131 @@ org.freedesktop.NetworkManager.wifi.share.protected yes org.freedesktop.NetworkManager.wifi.share.open yes org.freedesktop.NetworkManager.settings.modify.system yes org.freedesktop.NetworkManager.settings.modify.own yes -org.freedesktop.NetworkManager.settings.modify.hostname auth - </screen> +org.freedesktop.NetworkManager.settings.modify.hostname auth</screen> + <para> + This command shows configured polkit permissions for various NetworkManager + operations. These permissions or actions (using polkit language) are configured + by a system administrator and are not meant to be changed by users. The usual + place for the polkit configuration is /usr/share/polkit-1/actions/org.freedesktop.NetworkManager.policy. + <emphasis>pkaction</emphasis> command can display description for polkit actions. + <synopsis><command> + pkaction --action-id org.freedesktop.NetworkManager.network-control --verbose + </command></synopsis> + More information about polkit can be found at http://www.freedesktop.org/wiki/Software/polkit. + </para> </example> - <para> - This command shows configured polkit permissions for various NetworkManager - operations. These permissions or actions (using polkit language) are configured - by a system administrator and are not meant to be changed by users. The usual - place for the polkit configuration is /usr/share/polkit-1/actions/org.freedesktop.NetworkManager.policy. - <emphasis>pkaction</emphasis> command can display description for polkit actions. - <synopsis><command> -pkaction --action-id org.freedesktop.NetworkManager.network-control --verbose - </command></synopsis> - More information about polkit can be found at http://www.freedesktop.org/wiki/Software/polkit. - </para> <example><title>Listing NetworkManager log level and domains</title> - <screen> -<userinput>$ nmcli general logging</userinput> +<screen><userinput>$ nmcli general logging</userinput> 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, WIMAX,INFINIBAND,FIREWALL,ADSL,BOND,VLAN,BRIDGE,DBUS_PROPS,TEAM,CONCHECK,DC -B,DISPATCH - </screen> +B,DISPATCH</screen> + <para> + This command shows current NetworkManager logging status. + </para> </example> - <para> - This command shows current NetworkManager logging status. - </para> <example><title>Changing NetworkManager logging</title> - <screen> -<userinput>$ nmcli g log level DEBUG domains CORE,ETHER,IP</userinput> -<userinput>$ nmcli g log level INFO domains DEFAULT</userinput> - </screen> +<screen><userinput>$ nmcli g log level DEBUG domains CORE,ETHER,IP</userinput> +<userinput>$ nmcli g log level INFO domains DEFAULT</userinput></screen> + <para> + 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 + <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> manual page + for available logging levels and domains. + </para> </example> - <para> - 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 - <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> manual page - for available logging levels and domains. - </para> <example><title>Adding a bonding master and two slave connection profiles</title> - <screen> -<userinput>$ nmcli con add type bond ifname mybond0 mode active-backup</userinput> +<screen><userinput>$ nmcli con add type bond ifname mybond0 mode active-backup</userinput> <userinput>$ nmcli con add type ethernet ifname eth1 master mybond0</userinput> -<userinput>$ nmcli con add type ethernet ifname eth2 master mybond0</userinput> - </screen> +<userinput>$ nmcli con add type ethernet ifname eth2 master mybond0</userinput></screen> + <para> + This example demonstrates adding a bond master connection and two slaves. The + first command adds a master bond connection, naming the bonding interface + <emphasis>mybond0</emphasis> and using <emphasis>active-backup</emphasis> mode. + The next two commands add slaves connections, both enslaved to <emphasis>mybond0</emphasis>. + The first slave will be bound to <emphasis>eth1</emphasis> interface, the second to + <emphasis>eth2</emphasis>. + </para> </example> - <para> - This example demonstrates adding a bond master connection and two slaves. The - first command adds a master bond connection, naming the bonding interface - <emphasis>mybond0</emphasis> and using <emphasis>active-backup</emphasis> mode. - The next two commands add slaves connections, both enslaved to <emphasis>mybond0</emphasis>. - The first slave will be bound to <emphasis>eth1</emphasis> interface, the second to - <emphasis>eth2</emphasis>. - </para> <example><title>Adding a team master and two slave connection profiles</title> - <screen> -<userinput>$ nmcli con add type team con-name Team1 ifname Team1 config team1-master-json.conf</userinput> +<screen><userinput>$ nmcli con add type team con-name Team1 ifname Team1 config team1-master-json.conf</userinput> <userinput>$ nmcli con add type ethernet con-name Team1-slave1 ifname em1 master Team1</userinput> -<userinput>$ nmcli con add type ethernet con-name Team1-slave2 ifname em2 master Team1</userinput> - </screen> +<userinput>$ nmcli con add type ethernet con-name Team1-slave2 ifname em2 master Team1</userinput></screen> + <para> + 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 + the team interface and the profile <emphasis>Team1</emphasis>. The team configuration + for the master is read from <emphasis>team1-master-json.conf</emphasis> file. Later, you can + change the configuration with <emphasis>modify</emphasis> command + (<emphasis role="bold">nmcli con modify Team1 team.config team1-master-another-json.conf</emphasis>). + The last two commands add slaves profiles, both enslaved to <emphasis>Team1</emphasis>. + The first slave will be bound to <emphasis>em1</emphasis> interface, the second to + <emphasis>em2</emphasis>. The slaves don't specify <emphasis>config</emphasis> and thus + <emphasis>teamd</emphasis> will use its default configuration. You will activate the whole setup + by activating both slaves: +<screen> <userinput>$ nmcli con up Team1-slave1</userinput> + <userinput>$ nmcli con up Team1-slave2</userinput></screen> + 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 + automatically and you need to activate it manually. + </para> </example> - <para> - 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 - the team interface and the profile <emphasis>Team1</emphasis>. The team configuration - for the master is read from <emphasis>team1-master-json.conf</emphasis> file. Later, you can - change the configuration with <emphasis>modify</emphasis> command - (<emphasis role="bold">nmcli con modify Team1 team.config team1-master-another-json.conf</emphasis>). - The last two commands add slaves profiles, both enslaved to <emphasis>Team1</emphasis>. - The first slave will be bound to <emphasis>em1</emphasis> interface, the second to - <emphasis>em2</emphasis>. The slaves don't specify <emphasis>config</emphasis> and thus - <emphasis>teamd</emphasis> will use its default configuration. You will activate the whole setup - by activating both slaves: - <screen> -<userinput>$ nmcli con up Team1-slave1</userinput> -<userinput>$ nmcli con up Team1-slave2</userinput> - </screen> - 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 - automatically and you need to activate it manually. - </para> <example><title>Adding a bridge and two slave profiles</title> - <screen> -<userinput>$ nmcli con add type bridge con-name TowerBridge ifname TowerBridge</userinput> +<screen><userinput>$ nmcli con add type bridge con-name TowerBridge ifname TowerBridge</userinput> <userinput>$ nmcli con add type ethernet con-name br-slave-1 ifname ens3 master TowerBridge</userinput> <userinput>$ nmcli con add type ethernet con-name br-slave-2 ifname ens4 master TowerBridge</userinput> -<userinput>$ nmcli con modify TowerBridge bridge.stp no</userinput> - </screen> +<userinput>$ nmcli con modify TowerBridge bridge.stp no</userinput></screen> + <para> + This example demonstrates adding a bridge master connection and two slaves. The + first command adds a master bridge connection, naming the bridge interface and + the profile as <emphasis>TowerBridge</emphasis>. + The next two commands add slaves profiles, both will be enslaved to + <emphasis>TowerBridge</emphasis>. + The first slave will be tied to <emphasis>ens3</emphasis> interface, the second to + <emphasis>ens4</emphasis>. + The last command will disable 802.1D STP for the TowerBridge profile. + </para> </example> - <para> - This example demonstrates adding a bridge master connection and two slaves. The - first command adds a master bridge connection, naming the bridge interface and - the profile as <emphasis>TowerBridge</emphasis>. - The next two commands add slaves profiles, both will be enslaved to - <emphasis>TowerBridge</emphasis>. - The first slave will be tied to <emphasis>ens3</emphasis> interface, the second to - <emphasis>ens4</emphasis>. - The last command will disable 802.1D STP for the TowerBridge profile. - </para> <example><title>Adding an ethernet connection profile with manual IP configuration</title> - <screen> -<userinput>$ nmcli con add con-name my-con-em1 ifname em1 type ethernet \ +<screen><userinput>$ 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</userinput> <userinput>$ nmcli con mod my-con-em1 ipv4.dns "8.8.8.8 8.8.4.4"</userinput> <userinput>$ nmcli con mod my-con-em1 +ipv4.dns 1.2.3.4</userinput> <userinput>$ nmcli con mod my-con-em1 ipv6.dns "2001:4860:4860::8888 2001:4860:4860::8844"</userinput> -<userinput>$ nmcli -p con show my-con-em1</userinput> - </screen> +<userinput>$ nmcli -p con show my-con-em1</userinput></screen> + <para> + The first command adds an Ethernet connection profile named <emphasis>my-con-em1</emphasis> + that is bound to interface name <emphasis>em1</emphasis>. The profile is configured + with static IP addresses. Three addresses are added, two IPv4 addresses and one IPv6. + The first IP 192.168.100.100 has a prefix of 24 (netmask equivalent of 255.255.255.0). + Gateway entry will become the default route if this profile is activated on em1 interface + (and there is no connection with higher priority). The next two addresses do not + specify a prefix, so a default prefix will be used, i.e. 32 for IPv4 and 128 for IPv6. + The second, third and fourth commands modify DNS parameters of the new connection profile. + The last <emphasis>con show</emphasis> command displays the profile so that all + parameters can be reviewed. + </para> </example> - <para> - The first command adds an Ethernet connection profile named <emphasis>my-con-em1</emphasis> - that is bound to interface name <emphasis>em1</emphasis>. The profile is configured - with static IP addresses. Three addresses are added, two IPv4 addresses and one IPv6. - The first IP 192.168.100.100 has a prefix of 24 (netmask equivalent of 255.255.255.0). - Gateway entry will become the default route if this profile is activated on em1 interface - (and there is no connection with higher priority). The next two addresses do not - specify a prefix, so a default prefix will be used, i.e. 32 for IPv4 and 128 for IPv6. - The second, third and fourth commands modify DNS parameters of the new connection profile. - The last <emphasis>con show</emphasis> command displays the profile so that all - parameters can be reviewed. - </para> <example><title>Escaping colon characters in tabular mode</title> - <screen> -<userinput>$ nmcli -t -f general -e yes -m tab dev show eth0</userinput> +<screen><userinput>$ nmcli -t -f general -e yes -m tab dev show eth0</userinput> 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: ethernet-13:89cbcbc6-dc85-456c-9c8b-bd828fee3917:/org/freedesktop/NetworkMa -nager/ActiveConnection/9 - </screen> +nager/ActiveConnection/9</screen> + <para> + This example shows escaping colon characters in tabular mode. It may be + useful for script processing, because ':' is used as a field separator. + </para> </example> - <para> - This example shows escaping colon characters in tabular mode. It may be - useful for script processing, because ':' is used as a field separator. - </para> <example><title>nmcli usage in a NetworkManager dispatcher script to make Ethernet and Wi-Fi mutually exclusive</title> <programlisting> @@ -295,24 +273,22 @@ if [ "$2" = "down" ]; then enable_disable_wifi fi </programlisting> + <para> + This dispatcher script makes Wi-Fi mutually exclusive with wired + networking. When a wired interface is connected, Wi-Fi will be set + to airplane mode (rfkilled). When the wired interface is disconnected, + Wi-Fi will be turned back on. + Name this script e.g. 70-wifi-wired-exclusive.sh and put it into /etc/NetworkManager/dispatcher.d/ + directory. + See <citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry> + manual page for more information about NetworkManager dispatcher scripts. + </para> </example> - <para> - This dispatcher script makes Wi-Fi mutually exclusive with wired - networking. When a wired interface is connected, Wi-Fi will be set - to airplane mode (rfkilled). When the wired interface is disconnected, - Wi-Fi will be turned back on. - Name this script e.g. 70-wifi-wired-exclusive.sh and put it into /etc/NetworkManager/dispatcher.d/ - directory. - See <citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry> - manual page for more information about NetworkManager dispatcher scripts. - </para> - <para><emphasis role="bold">Example sessions of interactive connection editor</emphasis></para> <example><title>Adding an ethernet connection profile in interactive editor (a)</title> - <screen> -<userinput>$ nmcli connection edit type ethernet</userinput> +<screen><userinput>$ nmcli connection edit type ethernet</userinput> ===| nmcli interactive connection editor |=== @@ -538,13 +514,12 @@ Verify connection: OK nmcli> <userinput>save</userinput> Connection 'ethernet-4' (de89cdeb-a3e1-4d53-8fa0-c22546c775f4) successfully saved. -nmcli> <userinput>quit</userinput> - </screen> +nmcli> <userinput>quit</userinput></screen> + <para> + Example session in the nmcli interactive connection editor. + The scenario creates an Ethernet connection profile with static addressing (IPs and DNS). + </para> </example> - <para> - Example session in the nmcli interactive connection editor. - The scenario creates an Ethernet connection profile with static addressing (IPs and DNS). - </para> </refsect1> |