1
diff --git a/docs/configure-a-shared-connection.md b/docs/configure-a-shared-connection.md
2
0
new file mode 100644
0
new file mode 100644
3
index 0000000..61cbe87
4
--- /dev/null
5
+++ b/docs/configure-a-shared-connection.md
6
@@ -0,0 +1,27 @@
7
1
---
8
2
title: "Configure shared connections"
9
3
table_of_contents: True
10
4
---
11
5
12
6
# Configure shared connections
13
7
14
8
NetworkManager makes very easy to share connectivity, using the device
15
9
as a gateway to which other devices can connect. That requires running
16
10
commands similar to
17
11
18
12
```
19
13
$ nmcli c add con-name <name> type ethernet ifname <iface> ipv4.method shared ipv6.method ignore
20
14
$ nmcli c up <name>
21
15
```
22
16
23
17
where `<name>` is an arbitrary name we give to the connection and
24
18
`<iface>` is the name of the interface where external devices will
25
19
connect to. In this case we are using an ethernet interface
26
20
(`type ethernet`) and we provide IPv4 addresses, but this extends to other
27
21
interfaces and to IPv6.
28
22
29
23
When the connection is up, NM starts a DHCP server listening on
30
24
`<iface>` and changes the networking configuration so we can forward
31
25
packages and masquerading is enabled for the interface. Of course, for
32
26
this to work we need an interface different from `<iface>` that has
33
27
to have external connectivity.
34
diff --git a/docs/configure-cellular-connections.md b/docs/configure-cellular-connections.md
35
index 215f2dc..b2ad22b 100644
36
--- a/docs/configure-cellular-connections.md
37
+++ b/docs/configure-cellular-connections.md
38
@@ -5,6 +5,11 @@ table_of_contents: False
39
5
5
40
6
# Configure Cellular Connections
6
# Configure Cellular Connections
41
7
7
42
8
For cellular connections, first install the modem-manager snap with:
43
9
```
44
10
$ snap install modem-manager
45
11
```
46
12
47
8
Check whether a modem was properly detected via:
13
Check whether a modem was properly detected via:
48
9
14
49
10
```
15
```
50
@@ -15,7 +20,7 @@ Found 1 modems:
51
15
20
52
16
In this case we have just one modem, with index 0 (the number at the end of the DBus object path).
21
In this case we have just one modem, with index 0 (the number at the end of the DBus object path).
53
17
22
55
18
Show detailed information about the modem:
23
Show detailed information about the modem using that index:
56
19
24
57
20
```
25
```
58
21
$ sudo modem-manager.mmcli -m 0
26
$ sudo modem-manager.mmcli -m 0
59
@@ -86,15 +91,20 @@ $ nmcli c add type gsm ifname <interface> con-name <name> apn <operator_apn>
60
86
$ nmcli r wwan on
91
$ nmcli r wwan on
61
87
```
92
```
62
88
93
72
89
where &lt;interface&gt; is the string listed as “primary port” in the output from 'sudo mmcli -m &lt;N&gt;'
94
where &lt;interface&gt; is the string listed as “primary port” in the
73
90
(as previously described),
95
output from `sudo mmcli -m <N>` (as previously described),
74
91
&lt;name&gt; is an arbitrary name used to identify the connection, and &lt;operator_apn&gt; is
96
&lt;name&gt; is an arbitrary name used to identify the connection, and
75
92
the APN name for your cellular data plan.  Note that &lt;interface&gt; is usually a serial
97
&lt;operator_apn&gt; is the APN name for your cellular data plan.
76
93
port with pattern /dev/tty*, not a networking interface. The reason for ModemManager
98
Note that &lt;interface&gt; is usually a serial port with pattern
77
94
to use that instead of the networking interface is that this last one can appear/disappear
99
tty\* or a cdc-wdm\* device, not a networking interface. As these
78
95
dynamically while the ports do not if the hardware configuration remains unchanged.
100
interface names might change depending on the devices present in the
79
96
For instance, the networking interface can be ppp0, ppp1, etc., and it might be
101
system, a better alternative is to use the sysfs path shown by mmcli
80
97
different each time it is possible to have other ppp connections with, say, VPNs.
102
(device: ...) or use `'*'`, which will use any modem device detected
81
103
by MM:
82
104
83
105
```
84
106
sudo nmcli c add type gsm ifname '*' con-name <name> apn <operator_apn>
85
107
```
86
98
108
87
99
After executing these commands, NetworkManager will automatically try to bring up
109
After executing these commands, NetworkManager will automatically try to bring up
88
100
the cellular connection whenever ModemManager reports that the modem has
110
the cellular connection whenever ModemManager reports that the modem has
89
@@ -115,9 +125,9 @@ $ nmcli c modify <name> connection.autoconnect [yes|no]
90
115
$ nmcli c down <name>
125
$ nmcli c down <name>
91
116
```
126
```
92
117
127
96
118
Finally, note that we can provide the PIN (so it is entered automatically) or more
128
Finally, note that we can provide the PIN (so it is entered
97
119
needed APN provisioning information when creating/modifying the WWAN connection.
129
automatically) or additional APN provisioning information when
98
120
For instance:
130
creating/modifying the WWAN connection.  For instance:
99
121
131
100
122
```
132
```
101
123
$ nmcli c add type gsm ifname <interface> con-name <name> apn <operator_apn> username <user> password <password> pin <PIN>
133
$ nmcli c add type gsm ifname <interface> con-name <name> apn <operator_apn> username <user> password <password> pin <PIN>
102
diff --git a/docs/configure-wifi-access-points.md b/docs/configure-wifi-access-points.md
103
124
new file mode 100644
134
new file mode 100644
104
index 0000000..a87c517
105
--- /dev/null
106
+++ b/docs/configure-wifi-access-points.md
107
@@ -0,0 +1,24 @@
108
1
---
109
2
title: "Configure WiFi Access Points"
110
3
table_of_contents: True
111
4
---
112
5
113
6
# Configure WiFi Access Points
114
7
115
8
It is possible to create WiFi Access Points with the network-manager snap.
116
9
This can be done by running
117
10
118
11
```
119
12
$ nmcli d wifi hotspot ifname <wifi_iface> ssid <ssid> password <password>
120
13
```
121
14
122
15
where `<wifi_iface>` is the wifi network interface, `<ssid>` is the
123
16
SSID for the AP that we are creating and that will be visible to
124
17
devices connecting to it, and `<password>` is the access password
125
18
(that needs to have between 8-63 characters or 64 hexadecimal
126
19
characters). NM will create a connection called '`Hotspot <N>`' if
127
20
the command is successful.
128
21
129
22
The created AP offers by default a shared connection, so devices
130
23
connected to it should be able to access the Internet if the device
131
24
providing the AP has access too.
132
diff --git a/docs/configure-wifi-connections.md b/docs/configure-wifi-connections.md
133
index 4602dfd..aab3f9f 100644
134
--- a/docs/configure-wifi-connections.md
135
+++ b/docs/configure-wifi-connections.md
136
@@ -6,11 +6,11 @@ table_of_contents: True
137
6
# Configure WiFi Connections
6
# Configure WiFi Connections
138
7
7
139
8
This section explains how to establish a WiFi connection. It covers creating and
8
This section explains how to establish a WiFi connection. It covers creating and
141
9
modyfying connections as well as directly connecting.
9
modifying connections as well as directly connecting.
142
10
10
143
11
## Establish a Wireless Connection
11
## Establish a Wireless Connection
144
12
12
146
13
This section will show how to establish a wifi connection to the wireles
13
This section will show how to establish a wifi connection to the wireless
147
14
network. Note that directly connecting will implicitly create a connection (that
14
network. Note that directly connecting will implicitly create a connection (that
148
15
can be seen with "nmcli c"). The naming of such will follow "SSID N" pattern,
15
can be seen with "nmcli c"). The naming of such will follow "SSID N" pattern,
149
16
where N is a number.
16
where N is a number.
150
diff --git a/docs/edit-connections.md b/docs/edit-connections.md
151
index 0c9d087..15eadec 100644
152
--- a/docs/edit-connections.md
153
+++ b/docs/edit-connections.md
154
@@ -5,9 +5,9 @@ table_of_contents: True
155
5
5
156
6
# Edit Connections
6
# Edit Connections
157
7
7
161
8
This part will show you how to use a network-manager built-in editor to modify
8
This section shows how to use the network-manager built-in editor to
162
9
the connections as well as provide a reference for setting some of the
9
modify connections as well as provide a reference for changing some of
163
10
settings.
10
the settings.
164
11
11
165
12
## Using nmcli Console
12
## Using nmcli Console
166
13
13
167
@@ -88,7 +88,7 @@ IPv4 and IPv6 settings.
168
88
88
169
89
It is important to understand that every option can be modified using either the
89
It is important to understand that every option can be modified using either the
170
90
command-line or the editor. The advantage of the editor is that it shows which
90
command-line or the editor. The advantage of the editor is that it shows which
172
91
options are availabe for modification in contrast to the command-line which does
91
options are available for modification in contrast to the command-line which does
173
92
not.
92
not.
174
93
93
175
94
It is possible however to learn about the available settings from the
94
It is possible however to learn about the available settings from the
176
diff --git a/docs/enable-ethernet-support.md b/docs/enable-ethernet-support.md
177
95
deleted file mode 100644
95
deleted file mode 100644
178
index 1aebf45..0000000
179
--- a/docs/enable-ethernet-support.md
180
+++ /dev/null
181
@@ -1,38 +0,0 @@
182
1
---
183
2
title: "Enable Ethernet Support"
184
3
table_of_contents: False
185
4
---
186
5
187
6
# Enable Ethernet Support
188
7
189
8
The default netplan configuration files in Ubuntu Core leave management of
190
9
Ethernet devices to networkd. Therefore, to avoid conflicts, the
191
10
network-manager snap does not manage Ethernet devices by default. The user has
192
11
to take care to enable it after installation if desired.
193
12
194
13
## Configure System for Ethernet Support
195
14
196
15
Before following the instructions below, backup the contents of /etc/netplan to
197
16
be able to restore it at a later point.
198
17
199
18
Also, note that this change might lead to a system without properly configured
200
19
network connections, which would lead to problems accessing the device, so be
201
20
careful when doing this.
202
21
203
22
To enable ethernet support, you have to set the `ethernet.enable` property to
204
23
`true`.  See how to do this [here](reference/configuration/ethernet_support.md).
205
24
When this is done, configuration files for netplan are created so
206
25
network-manager is the default netplan renderer. When set to `false` (the
207
26
default), the NM snap explicitly disables the management of ethernet devices to
208
27
avoid conflicts with networkd.
209
28
210
29
Rebooting the system will be needed for the changes to take effect.
211
30
212
31
After the reboot, NetworkManager should automatically set up attached Ethernet
213
32
ports or use existing netplan configuration files to setup connections.
214
33
215
34
Once logged into the system you may check the current connection status by
216
35
217
36
```
218
37
$ nmcli c show
219
38
```
220
diff --git a/docs/faq.md b/docs/faq.md
221
index ede5b21..e84de9d 100644
222
--- a/docs/faq.md
223
+++ b/docs/faq.md
224
@@ -12,7 +12,8 @@ to provide solutions for them.
225
12
12
226
13
### Possible cause: Ethernet support is disabled for NetworkManager
13
### Possible cause: Ethernet support is disabled for NetworkManager
227
14
14
231
15
By default the network-manager snap disables Ethernet support to avoid conflicts
15
The core16 based network-manager snap (1.2.2 version) disables by default
232
16
with networkd/netplan which are used by default on Ubuntu Core 16. See
16
ethernet support to avoid conflicts
233
17
*[Enable Ethernet Support](enable-ethernet-support.md)* for details on how to
17
with networkd/netplan. See
234
18
*[NetworkManager and netplan](networkmanager-and-netplan.md)* for details on how to
235
18
enable it.
19
enable it.
236
diff --git a/docs/index.md b/docs/index.md
237
index 81dcc30..6909fc2 100644
238
--- a/docs/index.md
239
+++ b/docs/index.md
240
@@ -6,31 +6,32 @@ table_of_contents: False
241
6
# About NetworkManager
6
# About NetworkManager
242
7
7
243
8
NetworkManager is a system network service that manages your network
8
NetworkManager is a system network service that manages your network
245
9
devices and connections, attempts to keep network connectivity active
9
devices and connections and attempts to keep network connectivity active
246
10
when available. It manages Ethernet, WiFi, mobile broadband (WWAN) and
10
when available. It manages Ethernet, WiFi, mobile broadband (WWAN) and
247
11
PPPoE devices while also providing VPN integration with a variety of
11
PPPoE devices while also providing VPN integration with a variety of
249
12
different VPN serivces.
12
different VPN services.
250
13
13
253
14
By default network management on [Ubuntu Core](https://www.ubuntu.com/core) is
14
By default network management on [Ubuntu
254
15
handled by systemd's
15
Core](https://www.ubuntu.com/core) is handled by systemd's
255
16
[networkd](https://www.freedesktop.org/software/systemd/man/systemd-networkd.service.html)
16
[networkd](https://www.freedesktop.org/software/systemd/man/systemd-networkd.service.html)
260
17
and [netplan](https://launchpad.net/netplan). While NetworkManager has some
17
and [netplan](https://launchpad.net/netplan). However, when
261
18
support to handle netplan configuration files, Ethernet support is disabled by
18
NetworkManager is installed, it will take control of all networking
262
19
default and has to be turned on explicitly to avoid conflicts with existing
19
devices in the system by creating a netplan configuration file in which
263
20
network configuration.
20
it sets itself as the default network renderer.
264
21
21
265
22
## What NetworkManager Offers
22
## What NetworkManager Offers
266
23
23
271
24
The upstream NetworkManager project offers a wide range of features which are
24
The upstream NetworkManager project offers a wide range of features and
272
25
partially available in the snap version. However,
25
most, but not all of them, are available in the snap package at the
273
26
as the snap should be always delivered in high quality we don't have yet all
26
moment.
270
27
upstream features enabled.
274
28
27
275
29
Currently we provide support for the following high level features:
28
Currently we provide support for the following high level features:
276
30
29
277
31
 * WiFi connectivity
30
 * WiFi connectivity
278
32
 * WWAN connectivity (together with ModemManager)
31
 * WWAN connectivity (together with ModemManager)
279
33
 * Ethernet connectivity
32
 * Ethernet connectivity
280
33
 * WiFi access point creation
281
34
 * Shared connections
282
34
35
283
35
 Currently we do not support the following features:
36
 Currently we do not support the following features:
284
36
37
285
diff --git a/docs/installation.md b/docs/installation.md
286
index b031d79..c2d2a6a 100644
287
--- a/docs/installation.md
288
+++ b/docs/installation.md
289
@@ -5,7 +5,7 @@ table_of_contents: True
290
5
5
291
6
# Install NetworkManager
6
# Install NetworkManager
292
7
7
294
8
The NetworkManager snap is currently available from the Ubuntu Store. It can
8
The NetworkManager snap is currently available from the Snap Store. It can
295
9
be installed on any system that supports snaps but is only recommended on
9
be installed on any system that supports snaps but is only recommended on
296
10
[Ubuntu Core](https://www.ubuntu.com/core) at the moment.
10
[Ubuntu Core](https://www.ubuntu.com/core) at the moment.
297
11
11
298
@@ -13,49 +13,79 @@ You can install the snap with the following command:
299
13
13
300
14
```
14
```
301
15
 $ snap install network-manager
15
 $ snap install network-manager
304
16
 network-manager 1.2.2-10 from 'canonical' installed
16
 network-manager (1.10/stable) 1.10.6-7 from Canonical✓ installed
303
17
```
305
18
17
309
19
Although the network-manager snap is available from other channels (candidate, beta, edge),
18
```
307
20
only the stable version should be used for production devices. Their meaning is internal
308
21
to the development team of the network-manager snap.
310
22
19
311
23
All necessary plugs and slots will be automatically connected within the
20
All necessary plugs and slots will be automatically connected within the
312
24
installation process. You can verify this with:
21
installation process. You can verify this with:
313
25
22
314
26
```
23
```
321
27
$ snap interfaces network-manager
24
$ snap connections network-manager
322
28
Slot                     Plug
25
Interface              Plug                                   Slot                     Notes
323
29
:network-setup-observe   network-manager
26
dbus                   network-manager:wpa                    -                        -
324
30
:ppp                     network-manager
27
firewall-control       network-manager:firewall-control       :firewall-control        -
325
31
network-manager:service  network-manager:nmcli
28
hardware-observe       network-manager:hardware-observe       :hardware-observe        -
326
32
-                        network-manager:modem-manager
29
login-session-observe  network-manager:login-session-observe  :login-session-observe   -
327
30
modem-manager          network-manager:modem-manager          modem-manager:service    -
328
31
network                network-manager:network                :network                 -
329
32
network-manager        network-manager:nmcli                  network-manager:service  -
330
33
network-observe        network-manager:network-observe        :network-observe         -
331
34
network-setup-control  network-manager:network-setup-control  :network-setup-control   -
332
35
network-setup-observe  network-manager:network-setup-observe  :network-setup-observe   -
333
36
ppp                    network-manager:ppp                    :ppp                     -
334
37
335
33
```
38
```
336
34
39
339
35
**NOTE:** The _network-manager:modem-manager_ plug only gets connected when the
40
**NOTE:** The _network-manager:modem-manager_ plug only gets connected
340
36
_modem-manager_ snap is installed too. Otherwise it stays disconnected.
41
when the _modem-manager_ snap is installed too. Otherwise it stays
341
42
disconnected. Similarly, there is a _network-manager:wpa_ plug in case
342
43
we would want to use a custom wpa supplicant snap instead of the one
343
44
supplied by the core snap (this is not generally recommended).
344
37
45
348
38
Once the installation has successfully finished the
46
Once the installation has successfully finished the NetworkManager
349
39
NetworkManager service is running in the background. You can check its current
47
service is running in the background. You can check its current status
350
40
status with
48
with
351
41
49
352
42
```
50
```
359
43
 $ systemctl status snap.networkmanager
51
 $ systemctl status snap.network-manager.networkmanager.service 
360
44
 ● snap.networkmanager.service - Service for snap application networkmanager
52
 ● snap.network-manager.networkmanager.service - Service for snap application network-manager.networkmanager
361
45
   Loaded: loaded (/etc/systemd/system/snap.networkmanager.service; enabled; vendor preset: enabled)
53
    Loaded: loaded (/etc/systemd/system/snap.network-manager.networkmanager.service; enabled; vendor preset: enabled)
362
46
   Active: active (running) since Thu 2017-02-16 09:59:39 UTC; 16s ago
54
    Active: active (running) since Thu 2020-07-09 10:19:01 UTC; 6min ago
363
47
   Main PID: 1389 (networkmanager)
55
  Main PID: 2850 (NetworkManager)
364
48
   [...]
56
     Tasks: 3 (limit: 569)
365
57
    CGroup: /system.slice/snap.network-manager.networkmanager.service
366
58
            └─2850 /snap/network-manager/564/usr/sbin/NetworkManager --config-dir=/var/snap/network-manager/564/conf.d/ --config=/snap/network-manager/564/etc/NetworkManager/NetworkManager.conf --log-level=INFO --no-daemon
367
49
```
59
```
368
50
60
369
51
Now you have NetworkManager successfully installed.
61
Now you have NetworkManager successfully installed.
370
52
62
371
63
## network-manager tracks and channels
372
64
373
65
The network-manager snap has currently three tracks:
374
66
375
67
 * **20**: Contains upstream 1.22.10 and has a core20 base. The track name refers
376
68
   to the base snap and it is the convention being used at the moment.
377
69
 * **1.10**: Contains upstream 1.10.6 and has a core18 base. Nowadays, this is the one
378
70
   installed by default if the channel is not specified when running `snap install`.
379
71
   The track name refers to the upstream version. More modern releases have changed
380
72
   the convention so the track now refers to the base snap.
381
73
 * **latest**: Contains upstream 1.2.2 and has a core16 base. Despite the unfortunate
382
74
   name (there are historical reasons for that) it is the oldest version.
383
75
384
76
All these tracks are available with the usual risks: stable,
385
77
candidate, beta, and edge, but only the stable version should be used
386
78
for production devices. The meaning of the other risk levels is
387
79
internal to the development team of the network-manager snap.
388
80
389
53
## Next Steps
81
## Next Steps
390
54
82
392
55
 * [Enable Ethernet Support](enable-ethernet-support.md)
83
 * [NetworkManager and netplan](networkmanager-and-netplan.md)
393
56
 * [Explore Network Status](explore-network-status.md)
84
 * [Explore Network Status](explore-network-status.md)
394
57
 * [Configure WiFi Connections](configure-wifi-connections.md)
85
 * [Configure WiFi Connections](configure-wifi-connections.md)
395
86
 * [Configure WiFi Access Points](configure-wifi-access-points.md)
396
58
 * [Configure Cellular Connections](configure-cellular-connections.md)
87
 * [Configure Cellular Connections](configure-cellular-connections.md)
397
88
 * [Configure shared connections](configure-a-shared-connection.md)
398
59
 * [Edit Network Connections](edit-connections.md)
89
 * [Edit Network Connections](edit-connections.md)
399
60
 * [Routing Tables](routing-tables.md)
90
 * [Routing Tables](routing-tables.md)
400
61
 * [Logging Messages](logging-messages.md)
91
 * [Logging Messages](logging-messages.md)
401
diff --git a/docs/logging-messages.md b/docs/logging-messages.md
402
index d242808..5dd4679 100644
403
--- a/docs/logging-messages.md
404
+++ b/docs/logging-messages.md
405
@@ -5,10 +5,10 @@ table_of_contents: False
406
5
5
407
6
# Logging Messages
6
# Logging Messages
408
7
7
410
8
This section will show how to modify the logging levels by NetworkManager.
8
This section shows how to modify the logging levels by NetworkManager.
411
9
9
412
10
NetworkManager supports on the fly changing of the logging levels and allows for
10
NetworkManager supports on the fly changing of the logging levels and allows for
414
11
a fine control over what is logged.
11
a fine grained control over what is logged.
415
12
12
416
13
First check what is the current logging setup, type:
13
First check what is the current logging setup, type:
417
14
14
418
@@ -34,10 +34,10 @@ $ nmcli general logging [level <level> [domain <domain>]]
419
34
The &lt;level&gt; is the desired log level. You can choose from the following:
34
The &lt;level&gt; is the desired log level. You can choose from the following:
420
35
35
421
36
* **ERR:** will log only critical errors
36
* **ERR:** will log only critical errors
423
37
* **WARN:** will log warnin messages
37
* **WARN:** will log warning messages
424
38
* **INFO:** will log various informational messages
38
* **INFO:** will log various informational messages
425
39
* **DEBUG:** enables verbose logging for debugging purposes
39
* **DEBUG:** enables verbose logging for debugging purposes
426
40
40
427
41
&lt;domain&gt; is the category of messages that shall be logged with given
41
&lt;domain&gt; is the category of messages that shall be logged with given
428
42
severity. **WIFI** will include only WiFi related messages, **IP4** will include
42
severity. **WIFI** will include only WiFi related messages, **IP4** will include
430
43
only IPv4 related messages and so on..
43
only IPv4 related messages, and so on.
431
diff --git a/docs/metadata.yaml b/docs/metadata.yaml
432
index 82bf35f..12c634a 100644
433
--- a/docs/metadata.yaml
434
+++ b/docs/metadata.yaml
435
@@ -13,10 +13,14 @@ navigation:
436
13
        location: explore-network-status.md
13
        location: explore-network-status.md
437
14
      - title: Configure WiFi Connections
14
      - title: Configure WiFi Connections
438
15
        location: configure-wifi-connections.md
15
        location: configure-wifi-connections.md
439
16
      - title: Configure WiFi Access Points
440
17
        location: configure-wifi-access-points.md
441
16
      - title: Configure Cellular Connections
18
      - title: Configure Cellular Connections
442
17
        location: configure-cellular-connections.md
19
        location: configure-cellular-connections.md
445
18
      - title: Enable Ethernet Support
20
      - title: Configure shared connections
446
19
        location: enable-ethernet-support.md
21
        location: configure-a-shared-connection.md
447
22
      - title: NetworkManager and netplan
448
23
        location: networkmanager-and-netplan.md
449
20
      - title: Edit Connections
24
      - title: Edit Connections
450
21
        location: edit-connections.md
25
        location: edit-connections.md
451
22
      - title: Routing Tables
26
      - title: Routing Tables
452
@@ -27,10 +31,12 @@ navigation:
453
27
    children:
31
    children:
454
28
      - title: Snap Configuration
32
      - title: Snap Configuration
455
29
        children:
33
        children:
458
30
          - title: Ethernet Support
34
          - title: Default renderer
459
31
            location: reference/configuration/ethernet_support.md
35
            location: reference/snap-configuration/default_renderer.md
460
32
          - title: Debug
36
          - title: Debug
461
33
            location: reference/snap-configuration/debug.md
37
            location: reference/snap-configuration/debug.md
462
38
          - title: Connectivity check
463
39
            location: reference/snap-configuration/connectivity-check.md
464
34
          - title: Wake on WLAN
40
          - title: Wake on WLAN
465
35
            location: reference/snap-configuration/wowlan.md
41
            location: reference/snap-configuration/wowlan.md
466
36
          - title: WiFi Powersave
42
          - title: WiFi Powersave
467
diff --git a/docs/networkmanager-and-netplan.md b/docs/networkmanager-and-netplan.md
468
37
new file mode 100644
43
new file mode 100644
469
index 0000000..9f34e88
470
--- /dev/null
471
+++ b/docs/networkmanager-and-netplan.md
472
@@ -0,0 +1,31 @@
473
1
---
474
2
title: "NetworkManager and netplan"
475
3
table_of_contents: False
476
4
---
477
5
478
6
# NetworkManager and netplan
479
7
480
8
The default netplan configuration files in Ubuntu Core leave
481
9
management of networking devices to networkd. But, when
482
10
network-manager is installed, it creates new netplan configuration
483
11
files, setting itself as the default network renderer and taking
484
12
control of all devices.
485
13
486
14
It is possible to control this behavior with the `defaultrenderer`
487
15
snap option. It is set by default to `true`, but if we set it to
488
16
`false`, network-manager reverts the netplan configuration and
489
17
networkd takes control of the devices again. Note however that
490
18
networkd will take control only of devices explicitly configured by
491
19
netplan configuration files, which is usually only ethernet or wifi
492
20
devices. To do that:
493
21
494
22
```
495
23
snap set network-manager defaultrenderer=false
496
24
```
497
25
498
26
In the core16 snap (legacy), the behavior was different: networkd was
499
27
left as default renderer and the default netplan configuration was
500
28
unchanged when network-manager was installed. There was instead a
501
29
setting called `ethernet.enable` that was `false` by default. When set
502
30
to `true`, NetworkManager was set as the default network renderer
503
31
similarly as described above.
504
diff --git a/docs/reference/available-commands.md b/docs/reference/available-commands.md
505
index 18b3cec..b774403 100644
506
--- a/docs/reference/available-commands.md
507
+++ b/docs/reference/available-commands.md
508
@@ -17,3 +17,15 @@ NetworkManager service.
509
17
17
510
18
An explanatory description of the command and available options are available
18
An explanatory description of the command and available options are available
511
19
[here](https://developer.gnome.org/NetworkManager/1.2/nmcli.html)
19
[here](https://developer.gnome.org/NetworkManager/1.2/nmcli.html)
512
20
513
21
## network-manager.nmtui
514
22
515
23
nmtui is the Network Manager Text User Interface. It is a curses-based application
516
24
that allows easy configuration of connections and networking settings. Besides
517
25
network-manager.nmtui, these other three commands are available:
518
26
519
27
* network-manager.nmtui-edit
520
28
* network-manager.nmtui-connect
521
29
* network-manager.nmtui-hostname
522
30
523
31
More details can be found in the [manual page](https://developer.gnome.org/NetworkManager/stable/nmtui.html).
524
diff --git a/docs/reference/configuration/ethernet_support.md b/docs/reference/configuration/ethernet_support.md
525
20
deleted file mode 100644
32
deleted file mode 100644
526
index fbc5929..0000000
527
--- a/docs/reference/configuration/ethernet_support.md
528
+++ /dev/null
529
@@ -1,47 +0,0 @@
530
1
---
531
2
title: Ethernet Support
532
3
table_of_contents: true
533
4
---
534
5
535
6
# Ethernet Support
536
7
537
8
*Available since:* 1.2.2-12
538
9
539
10
The NetworkManager snap provides a configuration option to adjust
540
11
if it should manage ethernet network connections.
541
12
542
13
By default the NetworkManager snap **does not** manage ethernet network
543
14
devices as it would conflict with the default network management in
544
15
Ubuntu Core which is handled by [netplan](https://launchpad.net/netplan) and
545
16
[networkd](https://www.freedesktop.org/software/systemd/man/systemd-networkd.service.html).
546
17
547
18
## Enable Ethernet Support
548
19
549
20
To enable management of ethernet network devices the snap provides the
550
21
*ethernet.enable* configuration option.
551
22
552
23
This configuration option accepts the following values
553
24
554
25
 * **false (default):** Ethernet support is disabled. All network
555
26
 devices matching the expression 'en*' or 'eth*' will be ignored.
556
27
 * **true:** All ethernet devices available on the system will be
557
28
 managed by NetworkManager. networkd will not manage any of these
558
29
 anymore.
559
30
560
31
Changing the *ethernet* configuration option needs a reboot of the
561
32
device it's running on.
562
33
563
34
After the device has rebooted ethernet support is enabled NetworkManager will
564
35
take over management of all available ethernet network devices on the device.
565
36
566
37
NetworkManager will reuse existing configurations files from */etc/netplan*
567
38
when ethernet support is enabled. Those will marked as immutable inside
568
39
NetworkManager and any changes need to be written manually into the relevant
569
40
files in */etc/netplan*.
570
41
571
42
Example:
572
43
573
44
```
574
45
 $ snap set network-manager ethernet.enable=true
575
46
 $ sudo reboot
576
47
```
577
diff --git a/docs/reference/dbus-api.md b/docs/reference/dbus-api.md
578
index 7cece10..cc7b7f0 100644
579
--- a/docs/reference/dbus-api.md
580
+++ b/docs/reference/dbus-api.md
581
@@ -6,4 +6,4 @@ table_of_contents: False
582
6
# DBUS API
6
# DBUS API
583
7
7
584
8
Documentation of the DBus API is provided by the NetworkManager upstream project
8
Documentation of the DBus API is provided by the NetworkManager upstream project
586
9
[here](https://developer.gnome.org/NetworkManager/1.2/spec.html).
9
[here](https://developer.gnome.org/NetworkManager/stable/spec.html).
587
diff --git a/docs/reference/snap-configuration/connectivity-check.md b/docs/reference/snap-configuration/connectivity-check.md
588
10
new file mode 100644
10
new file mode 100644
589
index 0000000..c68cbe4
590
--- /dev/null
591
+++ b/docs/reference/snap-configuration/connectivity-check.md
592
@@ -0,0 +1,28 @@
593
1
---
594
2
title: Connectivity check
595
3
table_of_contents: true
596
4
---
597
5
598
6
# Connectivity check
599
7
600
8
Connectivity checking is a NetworkManager functionality that allows
601
9
periodically testing whether the system can actually access the
602
10
internet or not. The network-manager snap allows configuring this
603
11
feature by using the following snap settings:
604
12
605
13
* **connectivity.interval**: it specifies the number of seconds between checks.
606
14
  If set to 0, it disables connectivity check. Set to 300 by default.
607
15
* **connectivity.response**: This is the expected HTTP body response from the server
608
16
  specified by connectivity.uri.
609
17
* **connectivity.uri**: The URI where NM is going to periodically access to check connectivity.
610
18
611
19
More details on how these options work can be found in the connectivity section of
612
20
the [NetworkManager.conf configuration file documentation](https://developer.gnome.org/NetworkManager/stable/NetworkManager.conf.html).
613
21
614
22
Some example commands on how to set a check every three minutes using the
615
23
Ubuntu connectivity check server are
616
24
617
25
```
618
26
$ snap set network-manager connectivity.uri=http://connectivity-check.ubuntu.com/
619
27
$ snap set network-manager connectivity.interval=180
620
28
```
621
diff --git a/docs/reference/snap-configuration/debug.md b/docs/reference/snap-configuration/debug.md
622
index e16d17c..1e54976 100644
623
--- a/docs/reference/snap-configuration/debug.md
624
+++ b/docs/reference/snap-configuration/debug.md
625
@@ -9,7 +9,7 @@ Debug is a feature that controls the amount of logs produced by the network-mana
626
9
snap. It is useful for collecting information required to either report a bug or
9
snap. It is useful for collecting information required to either report a bug or
627
10
investigate a network-manager failure (if happens).
10
investigate a network-manager failure (if happens).
628
11
11
630
12
It is disabled by default and has to be explicitely turned on for usage.
12
It is disabled by default and has to be explicitly turned on for usage.
631
13
13
632
14
Note that the debug logs may contain sensitive information.
14
Note that the debug logs may contain sensitive information.
633
15
15
634
@@ -47,5 +47,5 @@ The debug information, when enabled, will be available in the journal and can
635
47
be viewed with:
47
be viewed with:
636
48
48
637
49
```
49
```
639
50
$ journalctl --no-pager -u snap.network-manager.networkmanager.service
50
$ journalctl --no-pager -l -u snap.network-manager.networkmanager.service
640
51
```
51
```
641
diff --git a/docs/reference/snap-configuration/default_renderer.md b/docs/reference/snap-configuration/default_renderer.md
642
52
new file mode 100644
52
new file mode 100644
643
index 0000000..a50ca48
644
--- /dev/null
645
+++ b/docs/reference/snap-configuration/default_renderer.md
646
@@ -0,0 +1,18 @@
647
1
---
648
2
title: Default renderer
649
3
table_of_contents: true
650
4
---
651
5
652
6
# Default renderer
653
7
654
8
The NetworkManager snap provides a configuration option,
655
9
`defaultrenderer`, to adjust if it should be the default network
656
10
renderer or not. By default, it is set to `true`. To change it:
657
11
658
12
```
659
13
snap set network-manager defaultrenderer=false
660
14
```
661
15
662
16
For the core16 snap, there is an option called `ethernet.enable` that
663
17
does basically the same. See the [NetworkManager and netplan](../../networkmanager-and-netplan.md)
664
18
section for more details.
665
diff --git a/docs/reference/snap-configuration/wifi-powersave.md b/docs/reference/snap-configuration/wifi-powersave.md
666
index 8b9e68f..1958697 100644
667
--- a/docs/reference/snap-configuration/wifi-powersave.md
668
+++ b/docs/reference/snap-configuration/wifi-powersave.md
669
@@ -7,7 +7,7 @@ table_of_contents: True
670
7
7
671
8
WiFi Powersave is a feature that allows a device to suspend its radio activity
8
WiFi Powersave is a feature that allows a device to suspend its radio activity
672
9
after a fixed period of inactivity. The device remains idle for a fixed time,
9
after a fixed period of inactivity. The device remains idle for a fixed time,
674
10
usualy about 100ms, and once it is reached it wakes up to check if the
10
usually about 100ms, and once it is reached it wakes up to check if the
675
11
infrastructure has any packets queued up for it.
11
infrastructure has any packets queued up for it.
676
12
12
677
13
The NetworkManager snap allows to configure this option by either enabling or
13
The NetworkManager snap allows to configure this option by either enabling or
678
diff --git a/docs/reference/snap-configuration/wowlan.md b/docs/reference/snap-configuration/wowlan.md
679
index 2ae0791..c4145af 100644
680
--- a/docs/reference/snap-configuration/wowlan.md
681
+++ b/docs/reference/snap-configuration/wowlan.md
682
@@ -8,7 +8,7 @@ table_of_contents: True
683
8
*Available since:* 1.2.2-11
8
*Available since:* 1.2.2-11
684
9
9
685
10
Wake on WLAN (called WoWLAN in the following) is a feature which allows a device
10
Wake on WLAN (called WoWLAN in the following) is a feature which allows a device
687
11
to be woken up from standby power states to faciliate device management. It is based
11
to be woken up from standby power states to facilitate device management. It is based
688
12
on the well well-established standard for Wake on LAN. The functionality is not entirely
12
on the well well-established standard for Wake on LAN. The functionality is not entirely
689
13
equivalent to Wake on LAN and there are some limitations.
13
equivalent to Wake on LAN and there are some limitations.
690
14
14
691
@@ -53,7 +53,7 @@ This configuration option accepts the following values:
692
53
 The content of the magic packet can be extended with the
53
 The content of the magic packet can be extended with the
693
54
 wifi.wake-on-wlan-password option to require the client to send a
54
 wifi.wake-on-wlan-password option to require the client to send a
694
55
 specific byte sequence functioning as a password so that not anyone
55
 specific byte sequence functioning as a password so that not anyone
696
56
 unpriviledged can wake up the system.
56
 unprivileged can wake up the system.
697
57
 * **gtk-rekey-failure:** A failure of a GTK rekey operation will cause the device to wake up.
57
 * **gtk-rekey-failure:** A failure of a GTK rekey operation will cause the device to wake up.
698
58
 * **4way-handshake:** Reiteration of the 4way handshake will cause the device to wake up.
58
 * **4way-handshake:** Reiteration of the 4way handshake will cause the device to wake up.
699
59
 * **rfkill-release:** Release of a rfkill will cause the device to wake up.
59
 * **rfkill-release:** Release of a rfkill will cause the device to wake up.
700
@@ -69,7 +69,7 @@ Example:
701
69
69
702
70
This configuration option accepts a textual value. If specified, the value will
70
This configuration option accepts a textual value. If specified, the value will
703
71
be used in addition to the wireless device MAC address to function as a password
71
be used in addition to the wireless device MAC address to function as a password
705
72
that disallows unpriviledged actors to wake up the device.
72
that disallows unprivileged actors to wake up the device.
706
73
73
707
74
Example:
74
Example:
708
75
75
709
diff --git a/docs/release-notes.md b/docs/release-notes.md
710
index 8a96cee..93de8d7 100644
711
--- a/docs/release-notes.md
712
+++ b/docs/release-notes.md
713
@@ -5,31 +5,56 @@ table_of_contents: False
714
5
5
715
6
# Release Notes
6
# Release Notes
716
7
7
722
8
The version numbers mentioned on this page correspond to those released in the
8
You can check with the following command which version you have
723
9
Ubuntu snap store.
9
currently installed:
719
10
720
11
You can check with the following command which version you have currently
721
12
installed:
724
13
10
725
14
```
11
```
726
15
$ snap info network-manager
12
$ snap info network-manager
727
16
name:      network-manager
13
name:      network-manager
730
17
summary:   "Network management based on NeworkManager"
14
summary:   Network Manager
731
18
publisher: canonical
15
publisher: Canonical✓
732
16
store-url: https://snapcraft.io/network-manager
733
17
contact:   https://help.ubuntu.com/community/NetworkManager
734
18
license:   unset
735
19
description: |
19
description: |
738
20
  Network management of wired Ethernet, WiFi and mobile data connection based on
20
  NetworkManager is a system network service that manages your network
739
21
  NetworkManager and ModemManager
21
  devices and connections, attempting to keep active network connectivity
740
22
  when available. It manages ethernet, WiFi, mobile broadband (WWAN) and
741
23
  PPPoE devices, provides VPN integration with a variety of different
742
24
  VPN serivces.
743
25
  Please find the source code for this track at:
744
26
    https://code.launchpad.net/~snappy-hwe-team/snappy-hwe-snaps/+git/network-manager/+ref/snap-1.10
745
22
commands:
27
commands:
750
23
  - nmcli
28
  - network-manager.nmcli
751
24
tracking:    stable
29
  - network-manager.nmtui
752
25
installed:   1.2.2-10 (73) 5MB -
30
  - network-manager.nmtui-connect
753
26
[...]
31
  - network-manager.nmtui-edit
754
32
  - network-manager.nmtui-hostname
755
33
services:
756
34
  network-manager.networkmanager: simple, enabled, active
757
35
snap-id:      RmBXKl6HO6YOC2DE4G2q1JzWImC04EUy
758
36
tracking:     1.10/stable
759
37
refresh-date: today at 10:18 UTC
760
38
channels:
761
39
  1.10/stable:      1.10.6-7      2020-06-29 (564) 4MB -
762
40
  1.10/candidate:   1.10.6-7      2020-06-29 (564) 4MB -
763
41
  1.10/beta:        1.10.6-7      2020-06-25 (564) 4MB -
764
42
  1.10/edge:        1.10.6-5-dev  2020-04-06 (542) 4MB -
765
43
  latest/stable:    1.2.2-25      2020-06-22 (554) 4MB -
766
44
  latest/candidate: 1.2.2-25      2020-06-19 (554) 4MB -
767
45
  latest/beta:      1.2.2-26      2020-07-07 (573) 4MB -
768
46
  latest/edge:      1.2.2-26-dev  2020-07-07 (569) 4MB -
769
47
  20/stable:        –                                  
770
48
  20/candidate:     –                                  
771
49
  20/beta:          1.22.10-1     2020-06-25 (561) 5MB -
772
50
  20/edge:          1.22.10-2-dev 2020-07-08 (580) 5MB -
773
51
installed:          1.10.6-7                 (564) 4MB -
774
52
775
27
```
53
```
776
28
</br>
777
29
## 1.2.2-11
778
30
54
784
31
 * Wake-on-WLAN can be configured via snap/nmcli
55
The detailed changelog for each revision can be consulted in the sources
785
32
 * Automatic reconfiguration of network devices when device comes back from a
56
for each track:
786
33
   low power state
57
787
34
 * Snap alias available for nmcli
58
* For track 20, [here](https://git.launchpad.net/~snappy-hwe-team/snappy-hwe-snaps/+git/network-manager/tree/ChangeLog?h=snap-20)
788
35
 * WiFi powersave is configurable via snap configuration
59
* For track 1.10, [here](https://git.launchpad.net/~snappy-hwe-team/snappy-hwe-snaps/+git/network-manager/tree/ChangeLog?h=snap-1.10)
789
60
* For track latest (note again this is not actually the more modern NM), [here](https://git.launchpad.net/~snappy-hwe-team/snappy-hwe-snaps/+git/network-manager/tree/ChangeLog)
Status:	Merged
Approved by:	Alfonso Sanchez-Beato on 2020-07-10
Approved revision:	3c8c77260a86470d37bec5f2cf9730e3719c4a45
Merged at revision:	60c38868f4747bf88a684a45009d9516353fcf1f
Proposed branch:	~alfonsosanchezbeato/snappy-hwe-snaps/+git/network-manager:update-docs
Merge into:	~snappy-hwe-team/snappy-hwe-snaps/+git/network-manager:master
Diff against target:	789 lines (+306/-140) 20 files modified dev/null (+0/-47) docs/configure-a-shared-connection.md (+27/-0) docs/configure-cellular-connections.md (+23/-13) docs/configure-wifi-access-points.md (+24/-0) docs/configure-wifi-connections.md (+2/-2) docs/edit-connections.md (+4/-4) docs/faq.md (+4/-3) docs/index.md (+13/-12) docs/installation.md (+54/-24) docs/logging-messages.md (+4/-4) docs/metadata.yaml (+10/-4) docs/networkmanager-and-netplan.md (+31/-0) docs/reference/available-commands.md (+12/-0) docs/reference/dbus-api.md (+1/-1) docs/reference/snap-configuration/connectivity-check.md (+28/-0) docs/reference/snap-configuration/debug.md (+2/-2) docs/reference/snap-configuration/default_renderer.md (+18/-0) docs/reference/snap-configuration/wifi-powersave.md (+1/-1) docs/reference/snap-configuration/wowlan.md (+3/-3) docs/release-notes.md (+45/-20)
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Alfonso Sanchez-Beato	continuous-integration		Approve on 2020-07-10
System Enablement Bot	continuous-integration	2020-07-10	Needs Fixing on 2020-07-10
Review via email: mp+387195@code.launchpad.net