diff options
| author | Michael Biebl <biebl@debian.org> | 2024-12-25 20:36:29 +0100 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2024-12-25 20:36:29 +0100 |
| commit | e465722b908aa870bdc293b9a417d3c15294aa6d (patch) | |
| tree | 7c959d3b73f427d6c40522a7464eaa4531ef2f05 /man/nmcli-examples.7 | |
| parent | 56928734cbcf1d3a02fae4f152a541df1b04e04a (diff) | |
New upstream version 1.50.1 upstream/1.50.1
Diffstat (limited to 'man/nmcli-examples.7')
| -rw-r--r-- | man/nmcli-examples.7 | 835 |
1 files changed, 0 insertions, 835 deletions
diff --git a/man/nmcli-examples.7 b/man/nmcli-examples.7 deleted file mode 100644 index bbeacfed..00000000 --- a/man/nmcli-examples.7 +++ /dev/null @@ -1,835 +0,0 @@ -'\" t -.\" Title: nmcli-examples -.\" Author: -.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/02/2024 -.\" Manual: Examples -.\" Source: NetworkManager 1.50.0 -.\" Language: English -.\" -.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.50\&.0" "Examples" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -nmcli-examples \- usage examples of nmcli -.SH "SYNOPSIS" -.HP \w'\fBnmcli\fR\ 'u -\fBnmcli\fR [OPTIONS...] -.SH "DESCRIPTION" -.PP -\fInmcli\fR -is a command\-line client for NetworkManager\&. It allows controlling NetworkManager and reporting its status\&. For more information please refer to -\fBnmcli\fR(1) -manual page\&. -.PP -The purpose of this manual page is to provide you with various examples and usage scenarios of -\fInmcli\fR\&. -.SH "EXAMPLES" -.PP -\fBExample\ \&1.\ \&Listing available Wi\-Fi APs\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli device wifi list\fR -* SSID MODE CHAN RATE SIGNAL BARS SECURITY - netdatacomm_local Infra 6 54 Mbit/s 37 ▂▄__ WEP -* F1 Infra 11 54 Mbit/s 98 ▂▄▆█ WPA1 - LoremCorp Infra 1 54 Mbit/s 62 ▂▄▆_ WPA2 802\&.1X - Internet Infra 6 54 Mbit/s 29 ▂___ WPA1 - HPB110a\&.F2672A Ad\-Hoc 6 54 Mbit/s 22 ▂___ \-\- - Jozinet Infra 1 54 Mbit/s 19 ▂___ WEP - VOIP Infra 1 54 Mbit/s 20 ▂___ WEP - 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 -.fi -.if n \{\ -.RE -.\} -.PP -This command shows how to list available Wi\-Fi networks (APs)\&. You can also use -\fI\-\-fields\fR -option for displaying different columns\&. -\fBnmcli \-f all dev wifi list\fR -will show all of them\&. -.PP -\fBExample\ \&2.\ \&Connect to a password\-protected wifi network\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli device wifi connect "$SSID" password "$PASSWORD"\fR -.fi -.if n \{\ -.RE -.\} -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli \-\-ask device wifi connect "$SSID"\fR -.fi -.if n \{\ -.RE -.\} -.PP -\fBExample\ \&3.\ \&Showing general information and properties for a Wi\-Fi interface\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli \-p \-f general,wifi\-properties device show wlan0\fR -=========================================================================== - Device details (wlan0) -=========================================================================== -GENERAL\&.DEVICE: wlan0 -GENERAL\&.TYPE: wifi -GENERAL\&.VENDOR: Intel Corporation -GENERAL\&.PRODUCT: PRO/Wireless 5100 AGN [Shiloh] Network Connection -GENERAL\&.DRIVER: iwlwifi -GENERAL\&.DRIVER\-VERSION: 3\&.8\&.13\-100\&.fc17\&.x86_64 -GENERAL\&.FIRMWARE\-VERSION: 8\&.83\&.5\&.1 build 33692 -GENERAL\&.HWADDR: 00:1E:65:37:A1:D3 -GENERAL\&.MTU: 1500 -GENERAL\&.STATE: 100 (connected) -GENERAL\&.REASON: 0 (No reason given) -GENERAL\&.UDI: /sys/devices/pci0000:00/0000:00:1c\&.1/net/wlan0 -GENERAL\&.IP\-IFACE: wlan0 -GENERAL\&.IS\-SOFTWARE: no -GENERAL\&.NM\-MANAGED: yes -GENERAL\&.AUTOCONNECT: yes -GENERAL\&.FIRMWARE\-MISSING: no -GENERAL\&.CONNECTION: My Alfa WiFi -GENERAL\&.CON\-UUID: 85194f4c\-d496\-4eec\-bae0\-d880b4cbcf26 -GENERAL\&.CON\-PATH: /org/freedesktop/NetworkManager/ActiveConnection/ -10 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -WIFI\-PROPERTIES\&.WEP: yes -WIFI\-PROPERTIES\&.WPA: yes -WIFI\-PROPERTIES\&.WPA2: yes -WIFI\-PROPERTIES\&.TKIP: yes -WIFI\-PROPERTIES\&.CCMP: yes -WIFI\-PROPERTIES\&.AP: no -WIFI\-PROPERTIES\&.ADHOC: yes -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -.fi -.if n \{\ -.RE -.\} -.PP -This command shows information about a Wi\-Fi device\&. -.PP -\fBExample\ \&4.\ \&Listing NetworkManager polkit permissions\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli general permissions\fR -PERMISSION VALUE -org\&.freedesktop\&.NetworkManager\&.enable\-disable\-network yes -org\&.freedesktop\&.NetworkManager\&.enable\-disable\-wifi yes -org\&.freedesktop\&.NetworkManager\&.enable\-disable\-wwan yes -org\&.freedesktop\&.NetworkManager\&.enable\-disable\-wimax yes -org\&.freedesktop\&.NetworkManager\&.sleep\-wake no -org\&.freedesktop\&.NetworkManager\&.network\-control yes -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 -org\&.freedesktop\&.NetworkManager\&.settings\&.modify\&.global\-dns auth -org\&.freedesktop\&.NetworkManager\&.reload auth -.fi -.if n \{\ -.RE -.\} -.PP -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\&. -\fIpkaction\fR -command can display description for polkit actions\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fB - pkaction \-\-action\-id org\&.freedesktop\&.NetworkManager\&.network\-control \-\-verbose - \fR -.fi -.if n \{\ -.RE -.\} -.sp -More information about polkit can be found at http://www\&.freedesktop\&.org/wiki/Software/polkit\&. -.PP -\fBExample\ \&5.\ \&Listing NetworkManager log level and domains\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli general logging\fR -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 -.fi -.if n \{\ -.RE -.\} -.PP -This command shows current NetworkManager logging status\&. -.PP -\fBExample\ \&6.\ \&Changing NetworkManager logging\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli g log level DEBUG domains CORE,ETHER,IP\fR -$ \fBnmcli g log level INFO domains DEFAULT\fR -.fi -.if n \{\ -.RE -.\} -.PP -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 -\fBNetworkManager.conf\fR(5) -manual page for available logging levels and domains\&. -.PP -\fBExample\ \&7.\ \&Activating a VPN connection profile requiring interactive password input\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli \-\-ask con up my\-vpn\-con\fR -.fi -.if n \{\ -.RE -.\} -.PP -This command activates a VPN connection profile enabling nmcli to interact with the user (\*(Aq\-\-ask\*(Aq): this will allow nmcli to prompt for the VPN password on the command line when the -\fIpassword\-flags\fR -are set to \*(Aq0x02\*(Aq (\*(Aqalways ask\*(Aq, see -\fBnm-settings-nmcli\fR(5) -)\&. This is particularly useful for OTP based VPNs, as the user needs to be prompted for the password each time the connection is activated\&. -.PP -\fBExample\ \&8.\ \&Adding a bonding controller and two port connection profiles\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli con add type bond ifname mybond0 mode active\-backup\fR -$ \fBnmcli con add type ethernet ifname eth1 controller mybond0\fR -$ \fBnmcli con add type ethernet ifname eth2 controller mybond0\fR -.fi -.if n \{\ -.RE -.\} -.PP -This example demonstrates adding a bond controller connection and two ports\&. The first command adds a controller bond connection, naming the bonding interface -\fImybond0\fR -and using -\fIactive\-backup\fR -mode\&. The next two commands add port connections, both attached as port to -\fImybond0\fR\&. The first port will be bound to -\fIeth1\fR -interface, the second to -\fIeth2\fR\&. -.PP -\fBExample\ \&9.\ \&Adding a team controller and two port connection profiles\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli con add type team con\-name Team1 ifname Team1 config team1\-controller\-json\&.conf\fR -$ \fBnmcli con add type ethernet con\-name Team1\-port1 ifname em1 controller Team1\fR -$ \fBnmcli con add type ethernet con\-name Team1\-port2 ifname em2 controller Team1\fR -.fi -.if n \{\ -.RE -.\} -.PP -This example demonstrates adding a team controller connection profile and two ports\&. It is very similar to the bonding example\&. The first command adds a controller team profile, naming the team interface and the profile -\fITeam1\fR\&. The team configuration for the controller is read from -\fIteam1\-controller\-json\&.conf\fR -file\&. Later, you can change the configuration with -\fImodify\fR -command (\fBnmcli con modify Team1 team\&.config team1\-controller\-another\-json\&.conf\fR)\&. The last two commands add port profiles, both attached as port to -\fITeam1\fR\&. The first port will be bound to the -\fIem1\fR -interface, the second to -\fIem2\fR\&. The ports don\*(Aqt specify -\fIconfig\fR -and thus -\fIteamd\fR -will use its default configuration\&. You will activate the whole setup by activating both ports: -.sp -.if n \{\ -.RS 4 -.\} -.nf - $ \fBnmcli con up Team1\-port1\fR - $ \fBnmcli con up Team1\-port2\fR -.fi -.if n \{\ -.RE -.\} -.sp -By default, the created profiles are marked for auto\-activation\&. But if another connection has been activated on the device, the new profile won\*(Aqt activate automatically and you need to activate it manually\&. -.PP -\fBExample\ \&10.\ \&Adding a bridge and two port profiles\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli con add type bridge con\-name TowerBridge ifname TowerBridge\fR -$ \fBnmcli con add type ethernet con\-name br\-port\-1 ifname ens3 controller TowerBridge\fR -$ \fBnmcli con add type ethernet con\-name br\-port\-2 ifname ens4 controller TowerBridge\fR -$ \fBnmcli con modify TowerBridge bridge\&.stp no\fR -.fi -.if n \{\ -.RE -.\} -.PP -This example demonstrates adding a bridge controller connection and two ports\&. The first command adds a controller bridge connection, naming the bridge interface and the profile as -\fITowerBridge\fR\&. The next two commands add ports profiles, both will be attached as port to -\fITowerBridge\fR\&. The first port will be tied to -\fIens3\fR -interface, the second to -\fIens4\fR\&. The last command will disable 802\&.1D STP for the TowerBridge profile\&. -.PP -\fBExample\ \&11.\ \&Adding an ethernet connection profile with manual IP configuration\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli con add con\-name my\-con\-em1 ifname em1 type ethernet \e - ip4 192\&.168\&.100\&.100/24 gw4 192\&.168\&.100\&.1 ip4 1\&.2\&.3\&.4 ip6 abbe::cafe\fR -$ \fBnmcli con mod my\-con\-em1 ipv4\&.dns "8\&.8\&.8\&.8 8\&.8\&.4\&.4"\fR -$ \fBnmcli con mod my\-con\-em1 +ipv4\&.dns 1\&.2\&.3\&.4\fR -$ \fBnmcli con mod my\-con\-em1 ipv6\&.dns "2001:4860:4860::8888 2001:4860:4860::8844"\fR -$ \fBnmcli \-p con show my\-con\-em1\fR -.fi -.if n \{\ -.RE -.\} -.PP -The first command adds an Ethernet connection profile named -\fImy\-con\-em1\fR -that is bound to interface name -\fIem1\fR\&. 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 -\fIcon show\fR -command displays the profile so that all parameters can be reviewed\&. -.PP -\fBExample\ \&12.\ \&Convenient field values retrieval for scripting\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli \-g ip4\&.address connection show my\-con\-eth0\fR -192\&.168\&.1\&.12/24 -.fi -.if n \{\ -.RE -.\} -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli \-g ip4\&.address,ip4\&.dns connection show my\-con\-eth0\fR -192\&.168\&.1\&.12/24 -192\&.168\&.1\&.1 -.fi -.if n \{\ -.RE -.\} -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli \-g ip4 connection show my\-con\-eth0\fR -IP4:192\&.168\&.1\&.12/24:192\&.168\&.1\&.1::192\&.168\&.1\&.1:: -.fi -.if n \{\ -.RE -.\} -.PP -This example shows retrieval of ip4 connection field values via the \-\-get\-values option\&. Multiple comma separated fields can be provided: they will be printed one per line\&. If a whole section is provided instead of a single field, the name of the section will be printed followed by all the related field values on the same line\&. See also \-\-terse, \-\-mode, \-\-fields and \-\-escape options in -\fBnmcli\fR(1) -manual page for more customized output\&. -.PP -\fBExample\ \&13.\ \&Adding an Ethernet connection and configuring SR\-IOV VFs\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli con add type ethernet con\-name EthernetPF ifname em1\fR -$ \fBnmcli con modify EthernetPF sriov\&.total\-vfs 3 sriov\&.autoprobe\-drivers false\fR -$ \fBnmcli con modify EthernetPF sriov\&.vfs \*(Aq0 mac=00:11:22:33:44:55 vlans=10, 1 trust=true spoof\-check=false\*(Aq\fR -$ \fBnmcli con modify EthernetPF +sriov\&.vfs \*(Aq2 max\-tx\-rate=20\*(Aq\fR -.fi -.if n \{\ -.RE -.\} -.PP -This example demonstrates adding an Ethernet connection for physical function (PF) -\fIens4\fR -and configuring 3 SR\-IOV virtual functions (VFs) on it\&. The first VF is configured with MAC address 00:11:22:33:44:55 and VLAN 10, the second one has the -\fItrust\fR -and -\fIspoof\-check\fR -features respectively enabled and disabled\&. VF number 2 has a maximum transmission rate of 20Mbps\&. The kernel is instructed to not automatically instantiate a network interface for the VFs\&. -.PP -\fBExample\ \&14.\ \&Escaping colon characters in tabular mode\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli \-t \-f general \-e yes \-m tab dev show eth0\fR -GENERAL:eth0:ethernet:Intel Corporation:82567LM Gigabit Network Connection: -e1000e:2\&.1\&.4\-k:1\&.8\-3:00\e:22\e:68\e:15\e:29\e:21:1500:100 (connected):0 (No reas -on given):/sys/devices/pci0000\e:00/0000\e:00\e:19\&.0/net/eth0:eth0:yes:yes:no: -ethernet\-13:89cbcbc6\-dc85\-456c\-9c8b\-bd828fee3917:/org/freedesktop/NetworkMa -nager/ActiveConnection/9 -.fi -.if n \{\ -.RE -.\} -.PP -This example shows escaping colon characters in tabular mode\&. It may be useful for script processing, because \*(Aq:\*(Aq is used as a field separator\&. -.PP -\fBExample\ \&15.\ \&nmcli usage in a NetworkManager dispatcher script to make Ethernet and Wi\-Fi mutually exclusive\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -#!/bin/bash -export LC_ALL=C - -enable_disable_wifi () -{ - result=$(nmcli dev | grep "ethernet" | grep \-w "connected") - if [ \-n "$result" ]; then - nmcli radio wifi off - else - nmcli radio wifi on - fi -} - -if [ "$2" = "up" ]; then - enable_disable_wifi -fi - -if [ "$2" = "down" ]; then - enable_disable_wifi -fi - -.fi -.if n \{\ -.RE -.\} -.PP -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 -\fBNetworkManager\fR(8) -manual page for more information about NetworkManager dispatcher scripts\&. -.PP -\fBExample sessions of interactive connection editor\fR -.PP -\fBExample\ \&16.\ \&Adding an ethernet connection profile in interactive editor (a)\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli connection edit type ethernet\fR - -===| nmcli interactive connection editor |=== - -Adding a new \*(Aq802\-3\-ethernet\*(Aq connection - -Type \*(Aqhelp\*(Aq or \*(Aq?\*(Aq for available commands\&. -Type \*(Aqdescribe [<setting>\&.<prop>]\*(Aq for detailed property description\&. - -You may edit the following settings: connection, 802\-3\-ethernet (ethernet), -802\-1x, ipv4, ipv6, dcb -nmcli> \fBprint\fR -=========================================================================== - Connection details -=========================================================================== -connection\&.id: ethernet\-4 -connection\&.uuid: de89cdeb\-a3e1\-4d53\-8fa0\-c22546c775f4 -connection\&.interface\-name: \-\- -connection\&.type: 802\-3\-ethernet -connection\&.autoconnect: yes -connection\&.autoconnect\-priority: 0 -connection\&.timestamp: 0 -connection\&.read\-only: no -connection\&.permissions: -connection\&.zone: \-\- -connection\&.controller: \-\- -connection\&.port\-type: \-\- -connection\&.secondaries: -connection\&.gateway\-ping\-timeout: 0 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -802\-3\-ethernet\&.port: \-\- -802\-3\-ethernet\&.speed: 0 -802\-3\-ethernet\&.duplex: \-\- -802\-3\-ethernet\&.auto\-negotiate: yes -802\-3\-ethernet\&.mac\-address: \-\- -802\-3\-ethernet\&.cloned\-mac\-address: \-\- -802\-3\-ethernet\&.mac\-address\-blacklist: -802\-3\-ethernet\&.mtu: auto -802\-3\-ethernet\&.s390\-subchannels: -802\-3\-ethernet\&.s390\-nettype: \-\- -802\-3\-ethernet\&.s390\-options: -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -ipv4\&.method: auto -ipv4\&.dns: -ipv4\&.dns\-search: -ipv4\&.addresses: -ipv4\&.gateway: \-\- -ipv4\&.routes: -ipv4\&.route\-metric: \-1 -ipv4\&.ignore\-auto\-routes: no -ipv4\&.ignore\-auto\-dns: no -ipv4\&.dhcp\-client\-id: \-\- -ipv4\&.dhcp\-send\-hostname: yes -ipv4\&.dhcp\-hostname: \-\- -ipv4\&.never\-default: no -ipv4\&.may\-fail: yes -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -ipv6\&.method: auto -ipv6\&.dns: -ipv6\&.dns\-search: -ipv6\&.addresses: -ipv6\&.gateway: \-\- -ipv6\&.routes: -ipv6\&.route\-metric: \-1 -ipv6\&.ignore\-auto\-routes: no -ipv6\&.ignore\-auto\-dns: no -ipv6\&.never\-default: no -ipv6\&.may\-fail: yes -ipv6\&.ip6\-privacy: \-1 (unknown) -ipv6\&.dhcp\-hostname: \-\- -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -nmcli> \fBgoto ethernet\fR -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> \fBgoto ipv4\&.addresses\fR -nmcli ipv4\&.addresses> desc - -=== [addresses] === -[NM property description] -Array of IP addresses\&. - -[nmcli specific description] -Enter a list of IPv4 addresses formatted as: - ip[/prefix], ip[/prefix],\&.\&.\&. -Missing prefix is regarded as prefix of 32\&. - -Example: 192\&.168\&.1\&.5/24, 10\&.0\&.0\&.11/24 - -nmcli ipv4\&.addresses> set 192\&.168\&.1\&.100/24 -Do you also want to set \*(Aqipv4\&.method\*(Aq to \*(Aqmanual\*(Aq? [yes]: yes -nmcli ipv4\&.addresses> -nmcli ipv4\&.addresses> print -addresses: 192\&.168\&.1\&.100/24 -nmcli ipv4\&.addresses> back -nmcli ipv4> b -nmcli> \fBset ipv4\&.gateway 192\&.168\&.1\&.1\fR -nmcli> \fBverify\fR -Verify connection: OK -nmcli> \fBprint\fR -=========================================================================== - Connection details -=========================================================================== -connection\&.id: ethernet\-4 -connection\&.uuid: de89cdeb\-a3e1\-4d53\-8fa0\-c22546c775f4 -connection\&.interface\-name: \-\- -connection\&.type: 802\-3\-ethernet -connection\&.autoconnect: yes -connection\&.autoconnect\-priority: 0 -connection\&.timestamp: 0 -connection\&.read\-only: no -connection\&.permissions: -connection\&.zone: \-\- -connection\&.controller: \-\- -connection\&.port\-type: \-\- -connection\&.secondaries: -connection\&.gateway\-ping\-timeout: 0 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -802\-3\-ethernet\&.port: \-\- -802\-3\-ethernet\&.speed: 0 -802\-3\-ethernet\&.duplex: \-\- -802\-3\-ethernet\&.auto\-negotiate: yes -802\-3\-ethernet\&.mac\-address: \-\- -802\-3\-ethernet\&.cloned\-mac\-address: \-\- -802\-3\-ethernet\&.mac\-address\-blacklist: -802\-3\-ethernet\&.mtu: 1492 -802\-3\-ethernet\&.s390\-subchannels: -802\-3\-ethernet\&.s390\-nettype: \-\- -802\-3\-ethernet\&.s390\-options: -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -ipv4\&.method: manual -ipv4\&.dns: -ipv4\&.dns\-search: -ipv4\&.addresses: 192\&.168\&.1\&.100/24 -ipv4\&.gateway: 192\&.168\&.1\&.1 -ipv4\&.routes: -ipv4\&.route\-metric: \-1 -ipv4\&.ignore\-auto\-routes: no -ipv4\&.ignore\-auto\-dns: no -ipv4\&.dhcp\-client\-id: \-\- -ipv4\&.dhcp\-send\-hostname: yes -ipv4\&.dhcp\-hostname: \-\- -ipv4\&.never\-default: no -ipv4\&.may\-fail: yes -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -ipv6\&.method: auto -ipv6\&.dns: -ipv6\&.dns\-search: -ipv6\&.addresses: -ipv6\&.routes: -ipv6\&.route\-metric: \-1 -ipv6\&.ignore\-auto\-routes: no -ipv6\&.ignore\-auto\-dns: no -ipv6\&.never\-default: no -ipv6\&.may\-fail: yes -ipv6\&.ip6\-privacy: \-1 (unknown) -ipv6\&.dhcp\-hostname: \-\- -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -nmcli> \fBset ipv4\&.dns 8\&.8\&.8\&.8 8\&.8\&.4\&.4\fR -nmcli> \fBprint\fR -=========================================================================== - Connection details -=========================================================================== -connection\&.id: ethernet\-4 -connection\&.uuid: de89cdeb\-a3e1\-4d53\-8fa0\-c22546c775f4 -connection\&.interface\-name: \-\- -connection\&.type: 802\-3\-ethernet -connection\&.autoconnect: yes -connection\&.autoconnect\-priority: 0 -connection\&.timestamp: 0 -connection\&.read\-only: no -connection\&.permissions: -connection\&.zone: \-\- -connection\&.controller: \-\- -connection\&.port\-type: \-\- -connection\&.secondaries: -connection\&.gateway\-ping\-timeout: 0 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -802\-3\-ethernet\&.port: \-\- -802\-3\-ethernet\&.speed: 0 -802\-3\-ethernet\&.duplex: \-\- -802\-3\-ethernet\&.auto\-negotiate: yes -802\-3\-ethernet\&.mac\-address: \-\- -802\-3\-ethernet\&.cloned\-mac\-address: \-\- -802\-3\-ethernet\&.mac\-address\-blacklist: -802\-3\-ethernet\&.mtu: 1492 -802\-3\-ethernet\&.s390\-subchannels: -802\-3\-ethernet\&.s390\-nettype: \-\- -802\-3\-ethernet\&.s390\-options: -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -ipv4\&.method: manual -ipv4\&.dns: 8\&.8\&.8\&.8,8\&.8\&.4\&.4 -ipv4\&.dns\-search: -ipv4\&.addresses: 192\&.168\&.1\&.100/24 -ipv4\&.gateway: 192\&.168\&.1\&.1 -ipv4\&.routes: -ipv4\&.route\-metric: \-1 -ipv4\&.ignore\-auto\-routes: no -ipv4\&.ignore\-auto\-dns: no -ipv4\&.dhcp\-client\-id: \-\- -ipv4\&.dhcp\-send\-hostname: yes -ipv4\&.dhcp\-hostname: \-\- -ipv4\&.never\-default: no -ipv4\&.may\-fail: yes -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -ipv6\&.method: auto -ipv6\&.dns: -ipv6\&.dns\-search: -ipv6\&.addresses: -ipv6\&.gateway: \-\- -ipv6\&.routes: -ipv6\&.route\-metric: \-1 -ipv6\&.ignore\-auto\-routes: no -ipv6\&.ignore\-auto\-dns: no -ipv6\&.never\-default: no -ipv6\&.may\-fail: yes -ipv6\&.ip6\-privacy: \-1 (unknown) -ipv6\&.dhcp\-hostname: \-\- -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -nmcli> \fBverify\fR -Verify connection: OK -nmcli> \fBsave\fR -Connection \*(Aqethernet\-4\*(Aq (de89cdeb\-a3e1\-4d53\-8fa0\-c22546c775f4) successfully - saved\&. -nmcli> \fBquit\fR -.fi -.if n \{\ -.RE -.\} -.PP -Example session in the nmcli interactive connection editor\&. The scenario creates an Ethernet connection profile with static addressing (IPs and DNS)\&. -.PP -\fBExample\ \&17.\ \&Bluetooth connection profiles\fR -.PP -NetworkManger supports both connecting to NAP and DUN devices as a client\&. It also supports sharing the network via a NAP server\&. -.PP -For NAP client connections, NetworkManager automatically creates a suitable in\-memory profile for paired devices if none is available\&. You may use that generated profile directly, but you may also modify and persist it, which will prevent to automatically re\-create it\&. You may also create a profile from scratch\&. For example, the following uses DHCP and IPv6 autoconf for address configuration: -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli connection add type bluetooth con\-name "Profile for My Bluetooth Device (NAP)" autoconnect no bluetooth\&.type panu bluetooth\&.bdaddr "$BDADDR"\fR -.fi -.if n \{\ -.RE -.\} -.PP -For DUN connections, the user needs to configure modem settings and hence no profile gets created automatically\&. The modem settings depend on your device and you either need a "gsm" or a "csma" section\&. For example, -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli connection add type bluetooth con\-name "Profile for My Bluetooth Device (DUN)" autoconnect no bluetooth\&.type dun bluetooth\&.bdaddr "$BDADDR" gsm\&.apn apn\&.com\fR -.fi -.if n \{\ -.RE -.\} -.PP -Finally, you can create a bluetooth hotspot\&. BlueZ implements those as a bridge device, so such profiles also have a bridge section\&. Also, you probably want to set IP methods as "shared", so that clients get automatic IP addressing\&. Note that the "shared" IPv4 method requires dnsmasq to be available\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli connection add type bluetooth con\-name "My Bluetooth Hotspot" autoconnect no ifname btnap0 bluetooth\&.type nap ipv4\&.method shared ipv6\&.method shared\fR -.fi -.if n \{\ -.RE -.\} -.PP -\fBExample\ \&18.\ \&Offline use\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli \-\-offline con add type ethernet \*(Aq - conn\&.id eth0 \e - conn\&.interface\-name eth0 \e - >/sysroot/etc/NetworkManager/system\-connections/eth0\&.nmconnection\fR -.fi -.if n \{\ -.RE -.\} -.PP -Creates a connection file in keyfile format without using the NetworkManager service\&. This allows for use of familiar -\fBnmcli\fR -syntax in situations where the service is not running, such as during system installation of image provisioning and ensures the resulting file is correctly formatted\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli \-\-offline con modify type ethernet \*(Aq - conn\&.id eth0\-ipv6 \e - ipv4\&.method disabled \e - </sysroot/etc/NetworkManager/system\-connections/eth0\&.nmconnection \e - >/sysroot/etc/NetworkManager/system\-connections/eth0\-ipv6\&.nmconnection\fR -.fi -.if n \{\ -.RE -.\} -.PP -Read and write a connection file without using the NetworkManager service, modifying some properties along the way\&. -.PP -This allows templating of the connection profiles using familiar -\fBnmcli\fR -syntax in situations where the service is not running\&. -.PP -\fBExample\ \&19.\ \&Device Checkpoint and Restore\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli dev checkpoint eth0 \-\- nmcli dev dis eth0\fR -Device \*(Aqeth0\*(Aq successfully disconnected\&. -Type "Yes" to commit the changes: No -Checkpoint was removed\&. -.fi -.if n \{\ -.RE -.\} -.PP -In this example the device eth0 was disconnected with the eth0 checkpoint taken\&. The user didn\*(Aqt confirm that the change is good, so the eth0 was brought back to the state it was when the checkpoint was taken\&. -.PP -If the command being run unintentionaly brings down the remote connection (such as a -\fBssh\fR(1) -session) to the very machine it\*(Aqs being run on, the user wouldn\*(Aqt be able to confirm the success and the connectivity would end up being restored after a timeout\&. -.PP -If, on the other hand, the command results in a success, the user could just confirm, causing the checkpoint to be abandoned without a rollback: -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli dev checkpoint \-\- ip link del br0\fR -Type "Yes" to commit the changes: \fBYes\fR -.fi -.if n \{\ -.RE -.\} -.SH "SEE ALSO" -.PP -\fBnmcli\fR(1), -\fBNetworkManager\fR(8), -\fBNetworkManager.conf\fR(5), -\fBnm-settings-nmcli\fR(5), -\fBnm-online\fR(1), -\fBnm-applet\fR(1), -\fBnm-connection-editor\fR(1) |