From 0018d1f3cf71d680d7b6bceda55a5717244d8b26 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 16 Aug 2022 18:24:19 +0200 Subject: New upstream version 1.39.90 --- docs/api/html/NetworkManager-dispatcher.html | 5 +- .../html/NetworkManager-wait-online.service.html | 29 +- docs/api/html/NetworkManager.conf.html | 47 +- docs/api/html/NetworkManager.devhelp2 | 9 + docs/api/html/NetworkManager.html | 5 + docs/api/html/ch01.html | 104 +- docs/api/html/index.html | 106 +- docs/api/html/ix01.html | 54 +- docs/api/html/nm-dbus-types.html | 141 +- docs/api/html/nm-initrd-generator.html | 7 +- docs/api/html/nm-openvswitch.html | 8 +- docs/api/html/nm-settings-dbus.html | 1366 +++++++++++++------- docs/api/html/nm-settings-ifcfg-rh.html | 35 +- docs/api/html/nm-settings-nmcli.html | 1215 +++++++++-------- docs/api/html/nmcli-examples.html | 56 + docs/api/html/nmcli.html | 49 +- docs/api/html/ref-settings.html | 104 +- docs/api/html/settings-6lowpan.html | 4 +- docs/api/html/settings-802-11-olpc-mesh.html | 8 +- .../html/settings-802-11-wireless-security.html | 42 +- docs/api/html/settings-802-11-wireless.html | 42 +- docs/api/html/settings-802-1x.html | 96 +- docs/api/html/settings-802-3-ethernet.html | 34 +- docs/api/html/settings-adsl.html | 16 +- docs/api/html/settings-bluetooth.html | 6 +- docs/api/html/settings-bond-port.html | 4 +- docs/api/html/settings-bond.html | 6 +- docs/api/html/settings-bridge-port.html | 10 +- docs/api/html/settings-bridge.html | 58 +- docs/api/html/settings-cdma.html | 12 +- docs/api/html/settings-connection.html | 66 +- docs/api/html/settings-dcb.html | 32 +- docs/api/html/settings-dummy.html | 2 +- docs/api/html/settings-ethtool.html | 2 +- docs/api/html/settings-generic.html | 2 +- docs/api/html/settings-gsm.html | 30 +- docs/api/html/settings-hostname.html | 10 +- docs/api/html/settings-infiniband.html | 12 +- docs/api/html/settings-ip-tunnel.html | 28 +- docs/api/html/settings-ipv4.html | 62 +- docs/api/html/settings-ipv6.html | 68 +- docs/api/html/settings-macsec.html | 20 +- docs/api/html/settings-macvlan.html | 10 +- docs/api/html/settings-match.html | 10 +- docs/api/html/settings-ovs-bridge.html | 12 +- docs/api/html/settings-ovs-dpdk.html | 6 +- docs/api/html/settings-ovs-external-ids.html | 4 +- docs/api/html/settings-ovs-interface.html | 4 +- docs/api/html/settings-ovs-patch.html | 4 +- docs/api/html/settings-ovs-port.html | 14 +- docs/api/html/settings-ppp.html | 38 +- docs/api/html/settings-pppoe.html | 12 +- docs/api/html/settings-proxy.html | 10 +- docs/api/html/settings-serial.html | 12 +- docs/api/html/settings-sriov.html | 8 +- docs/api/html/settings-tc.html | 6 +- docs/api/html/settings-team-port.html | 16 +- docs/api/html/settings-team.html | 36 +- docs/api/html/settings-tun.html | 14 +- docs/api/html/settings-user.html | 4 +- docs/api/html/settings-veth.html | 4 +- docs/api/html/settings-vlan.html | 14 +- docs/api/html/settings-vpn.html | 14 +- docs/api/html/settings-vrf.html | 4 +- docs/api/html/settings-vxlan.html | 34 +- docs/api/html/settings-wifi-p2p.html | 8 +- docs/api/html/settings-wimax.html | 6 +- docs/api/html/settings-wireguard.html | 20 +- docs/api/html/settings-wpan.html | 12 +- 69 files changed, 2668 insertions(+), 1680 deletions(-) (limited to 'docs/api/html') diff --git a/docs/api/html/NetworkManager-dispatcher.html b/docs/api/html/NetworkManager-dispatcher.html index d9a80e2f..6c899110 100644 --- a/docs/api/html/NetworkManager-dispatcher.html +++ b/docs/api/html/NetworkManager-dispatcher.html @@ -283,8 +283,9 @@

CONNECTIVITY_STATE

The network connectivity state, which can take the values defined by the NMConnectivityState type, - from the org.freedesktop.NetworkManager D-Bus API: unknown, - none, portal, limited or full. Note: this variable will only + from the org.freedesktop.NetworkManager D-Bus API: UNKNOWN, + NONE, PORTAL, LIMITED + or FULL. Note: this variable will only be set for connectivity-change actions.

diff --git a/docs/api/html/NetworkManager-wait-online.service.html b/docs/api/html/NetworkManager-wait-online.service.html index 3f6d63d1..76b703a0 100644 --- a/docs/api/html/NetworkManager-wait-online.service.html +++ b/docs/api/html/NetworkManager-wait-online.service.html @@ -75,7 +75,8 @@ and how long NetworkManager-wait-online.service blocks.

/var/lib/NetworkManager/secret_key and /etc/machine-id

diff --git a/docs/api/html/ch01.html b/docs/api/html/ch01.html index e4cd603e..56eda1b0 100644 --- a/docs/api/html/ch01.html +++ b/docs/api/html/ch01.html @@ -24,160 +24,160 @@ Configuration Settings
-connection — General Connection Profile Settings +connection — General Connection Profile Settings
-6lowpan — 6LoWPAN Settings +6lowpan — 6LoWPAN Settings
-802-1x — IEEE 802.1x Authentication Settings +802-1x — IEEE 802.1x Authentication Settings
-adsl — ADSL Settings +adsl — ADSL Settings
-bluetooth — Bluetooth Settings +bluetooth — Bluetooth Settings
-bond — Bonding Settings +bond — Bonding Settings
-bridge — Bridging Settings +bridge — Bridging Settings
-bridge-port — Bridge Port Settings +bridge-port — Bridge Port Settings
-cdma — CDMA-based Mobile Broadband Settings +cdma — CDMA-based Mobile Broadband Settings
-dcb — Data Center Bridging Settings +dcb — Data Center Bridging Settings
-dummy — Dummy Link Settings +dummy — Dummy Link Settings
-ethtool — Ethtool Ethernet Settings +ethtool — Ethtool Ethernet Settings
-generic — Generic Link Settings +generic — Generic Link Settings
-gsm — GSM-based Mobile Broadband Settings +gsm — GSM-based Mobile Broadband Settings
-infiniband — Infiniband Settings +infiniband — Infiniband Settings
-ipv4 — IPv4 Settings +ipv4 — IPv4 Settings
-ipv6 — IPv6 Settings +ipv6 — IPv6 Settings
-ip-tunnel — IP Tunneling Settings +ip-tunnel — IP Tunneling Settings
-macsec — MACSec Settings +macsec — MACSec Settings
-macvlan — MAC VLAN Settings +macvlan — MAC VLAN Settings
-match — Match settings +match — Match settings
-802-11-olpc-mesh — OLPC Wireless Mesh Settings +802-11-olpc-mesh — OLPC Wireless Mesh Settings
-ovs-bridge — OvsBridge Link Settings +ovs-bridge — OvsBridge Link Settings
-ovs-dpdk — OvsDpdk Link Settings +ovs-dpdk — OvsDpdk Link Settings
-ovs-interface — Open vSwitch Interface Settings +ovs-interface — Open vSwitch Interface Settings
-ovs-patch — OvsPatch Link Settings +ovs-patch — OvsPatch Link Settings
-ovs-port — OvsPort Link Settings +ovs-port — OvsPort Link Settings
-ppp — Point-to-Point Protocol Settings +ppp — Point-to-Point Protocol Settings
-pppoe — PPP-over-Ethernet Settings +pppoe — PPP-over-Ethernet Settings
-proxy — WWW Proxy Settings +proxy — WWW Proxy Settings
-serial — Serial Link Settings +serial — Serial Link Settings
-sriov — SR-IOV settings +sriov — SR-IOV settings
-tc — Linux Traffic Control Settings +tc — Linux Traffic Control Settings
-team — Teaming Settings +team — Teaming Settings
-team-port — Team Port Settings +team-port — Team Port Settings
-tun — Tunnel Settings +tun — Tunnel Settings
-user — General User Profile Settings +user — General User Profile Settings
-vlan — VLAN Settings +vlan — VLAN Settings
-vpn — VPN Settings +vpn — VPN Settings
-vrf — VRF settings +vrf — VRF settings
-vxlan — VXLAN Settings +vxlan — VXLAN Settings
-wifi-p2p — Wi-Fi P2P Settings +wifi-p2p — Wi-Fi P2P Settings
-wimax — WiMax Settings +wimax — WiMax Settings
-802-3-ethernet — Wired Ethernet Settings +802-3-ethernet — Wired Ethernet Settings
-wireguard — WireGuard Settings +wireguard — WireGuard Settings
-802-11-wireless — Wi-Fi Settings +802-11-wireless — Wi-Fi Settings
-802-11-wireless-security — Wi-Fi Security Settings +802-11-wireless-security — Wi-Fi Security Settings
-wpan — IEEE 802.15.4 (WPAN) MAC Settings +wpan — IEEE 802.15.4 (WPAN) MAC Settings
-bond-port — Bond Port Settings +bond-port — Bond Port Settings
-hostname — Hostname settings +hostname — Hostname settings
-ovs-external-ids — OVS External IDs Settings +ovs-external-ids — OVS External IDs Settings
-veth — Veth Settings +veth — Veth Settings
diff --git a/docs/api/html/index.html b/docs/api/html/index.html index 81e05e56..89e8f738 100644 --- a/docs/api/html/index.html +++ b/docs/api/html/index.html @@ -16,7 +16,7 @@

- for NetworkManager 1.38.4 + for NetworkManager 1.39.90 The latest version of this documentation can be found on-line at https://networkmanager.dev/docs/api/latest/. @@ -120,160 +120,160 @@

Configuration Settings
-connection — General Connection Profile Settings +connection — General Connection Profile Settings
-6lowpan — 6LoWPAN Settings +6lowpan — 6LoWPAN Settings
-802-1x — IEEE 802.1x Authentication Settings +802-1x — IEEE 802.1x Authentication Settings
-adsl — ADSL Settings +adsl — ADSL Settings
-bluetooth — Bluetooth Settings +bluetooth — Bluetooth Settings
-bond — Bonding Settings +bond — Bonding Settings
-bridge — Bridging Settings +bridge — Bridging Settings
-bridge-port — Bridge Port Settings +bridge-port — Bridge Port Settings
-cdma — CDMA-based Mobile Broadband Settings +cdma — CDMA-based Mobile Broadband Settings
-dcb — Data Center Bridging Settings +dcb — Data Center Bridging Settings
-dummy — Dummy Link Settings +dummy — Dummy Link Settings
-ethtool — Ethtool Ethernet Settings +ethtool — Ethtool Ethernet Settings
-generic — Generic Link Settings +generic — Generic Link Settings
-gsm — GSM-based Mobile Broadband Settings +gsm — GSM-based Mobile Broadband Settings
-infiniband — Infiniband Settings +infiniband — Infiniband Settings
-ipv4 — IPv4 Settings +ipv4 — IPv4 Settings
-ipv6 — IPv6 Settings +ipv6 — IPv6 Settings
-ip-tunnel — IP Tunneling Settings +ip-tunnel — IP Tunneling Settings
-macsec — MACSec Settings +macsec — MACSec Settings
-macvlan — MAC VLAN Settings +macvlan — MAC VLAN Settings
-match — Match settings +match — Match settings
-802-11-olpc-mesh — OLPC Wireless Mesh Settings +802-11-olpc-mesh — OLPC Wireless Mesh Settings
-ovs-bridge — OvsBridge Link Settings +ovs-bridge — OvsBridge Link Settings
-ovs-dpdk — OvsDpdk Link Settings +ovs-dpdk — OvsDpdk Link Settings
-ovs-interface — Open vSwitch Interface Settings +ovs-interface — Open vSwitch Interface Settings
-ovs-patch — OvsPatch Link Settings +ovs-patch — OvsPatch Link Settings
-ovs-port — OvsPort Link Settings +ovs-port — OvsPort Link Settings
-ppp — Point-to-Point Protocol Settings +ppp — Point-to-Point Protocol Settings
-pppoe — PPP-over-Ethernet Settings +pppoe — PPP-over-Ethernet Settings
-proxy — WWW Proxy Settings +proxy — WWW Proxy Settings
-serial — Serial Link Settings +serial — Serial Link Settings
-sriov — SR-IOV settings +sriov — SR-IOV settings
-tc — Linux Traffic Control Settings +tc — Linux Traffic Control Settings
-team — Teaming Settings +team — Teaming Settings
-team-port — Team Port Settings +team-port — Team Port Settings
-tun — Tunnel Settings +tun — Tunnel Settings
-user — General User Profile Settings +user — General User Profile Settings
-vlan — VLAN Settings +vlan — VLAN Settings
-vpn — VPN Settings +vpn — VPN Settings
-vrf — VRF settings +vrf — VRF settings
-vxlan — VXLAN Settings +vxlan — VXLAN Settings
-wifi-p2p — Wi-Fi P2P Settings +wifi-p2p — Wi-Fi P2P Settings
-wimax — WiMax Settings +wimax — WiMax Settings
-802-3-ethernet — Wired Ethernet Settings +802-3-ethernet — Wired Ethernet Settings
-wireguard — WireGuard Settings +wireguard — WireGuard Settings
-802-11-wireless — Wi-Fi Settings +802-11-wireless — Wi-Fi Settings
-802-11-wireless-security — Wi-Fi Security Settings +802-11-wireless-security — Wi-Fi Security Settings
-wpan — IEEE 802.15.4 (WPAN) MAC Settings +wpan — IEEE 802.15.4 (WPAN) MAC Settings
-bond-port — Bond Port Settings +bond-port — Bond Port Settings
-hostname — Hostname settings +hostname — Hostname settings
-ovs-external-ids — OVS External IDs Settings +ovs-external-ids — OVS External IDs Settings
-veth — Veth Settings +veth — Veth Settings
Secret flag types
diff --git a/docs/api/html/ix01.html b/docs/api/html/ix01.html index 6bc77760..15c9933b 100644 --- a/docs/api/html/ix01.html +++ b/docs/api/html/ix01.html @@ -905,6 +905,8 @@
limit, vxlan
+
link-local, ipv4 +
link-watchers, team, team-port
listen-port, wireguard @@ -1028,7 +1030,7 @@
max-age, bridge
-
may-fail, ipv4, ipv6 +
may-fail, ipv4, ipv6
mcast-rejoin-count, team
@@ -1040,7 +1042,7 @@
metered, connection
-
method, ipv4, ipv6, proxy +
method, ipv4, ipv6, proxy
mka-cak, macsec
@@ -1052,13 +1054,15 @@
mppe-stateful, ppp
+
mptcp-flags, connection +
mru, ppp
-
mtu, cdma, gsm, infiniband, ip-tunnel, ppp, 802-3-ethernet, wireguard, 802-11-wireless +
mtu, cdma, gsm, infiniband, ipv6, ip-tunnel, ppp, 802-3-ethernet, wireguard, 802-11-wireless
-
mud-url, connection +
mud-url, connection
-
multi-connect, connection +
multi-connect, connection
multi-queue, tun
@@ -1099,7 +1103,7 @@
network-name, wimax
-
never-default, ipv4, ipv6 +
never-default, ipv4, ipv6
NM80211ApFlags, enum NM80211ApFlags
@@ -1147,6 +1151,8 @@
NMMetered, enum NMMetered
+
NMMptcpFlags, enum NMMptcpFlags +
NMRadioFlags, enum NMRadioFlags
NMRollbackResult, enum NMRollbackResult @@ -1247,7 +1253,7 @@
peers, wireguard
-
permissions, connection +
permissions, connection
persistent, vpn
@@ -1369,11 +1375,11 @@

R

-
ra-timeout, ipv6 +
ra-timeout, ipv6
rate, 802-11-wireless
-
read-only, connection +
read-only, connection
refuse-chap, ppp
@@ -1391,15 +1397,15 @@
require-mppe-128, ppp
-
required-timeout, ipv4, ipv6 +
required-timeout, ipv4, ipv6
-
route-data, ipv4, ipv6 +
route-data, ipv4, ipv6
-
route-metric, ipv4, ipv6 +
route-metric, ipv4, ipv6
-
route-table, ipv4, ipv6 +
route-table, ipv4, ipv6
-
routes, ipv4, ipv6 +
routes, ipv4, ipv6
rsc, vxlan
@@ -1436,7 +1442,7 @@
s390-subchannels, 802-3-ethernet
-
secondaries, connection +
secondaries, connection
secrets, vpn
@@ -1458,7 +1464,7 @@
sim-operator-id, gsm
-
slave-type, connection +
slave-type, connection
source-port-max, vxlan
@@ -1468,7 +1474,7 @@
ssid, 802-11-olpc-mesh, 802-11-wireless
-
stable-id, connection +
stable-id, connection
sticky, team-port
@@ -1497,9 +1503,9 @@
timeout, vpn
-
timestamp, connection +
timestamp, connection
-
token, ipv6 +
token, ipv6
tos, ip-tunnel, vxlan
@@ -1511,7 +1517,7 @@
tx-power, 802-11-wireless
-
type, connection, bluetooth, ovs-interface +
type, connection, bluetooth, ovs-interface
@@ -1522,7 +1528,7 @@
username, adsl, cdma, gsm, pppoe
-
uuid, connection +
uuid, connection
@@ -1600,7 +1606,9 @@

W

-
wait-device-timeout, connection +
wait-activation-delay, connection +
+
wait-device-timeout, connection
wake-on-lan, 802-3-ethernet
@@ -1652,7 +1660,7 @@

Z

-
zone, connection +
zone, connection
diff --git a/docs/api/html/nm-dbus-types.html b/docs/api/html/nm-dbus-types.html index 4c90a748..9935f48c 100644 --- a/docs/api/html/nm-dbus-types.html +++ b/docs/api/html/nm-dbus-types.html @@ -3070,7 +3070,7 @@

enum NMMetered

-

The NMMetered enum has two different purposes: one is to configure "connection.metered" setting of a connection profile in NMSettingConnection, and the other is to express the actual metered state of the NMDevice at a given moment.

+

The NMMetered enum has two different purposes: one is to configure "connection.metered" setting of a connection profile in NMSettingConnection, and the other is to express the actual metered state of the NMDevice at a given moment.

For the connection profile only NM_METERED_UNKNOWN, NM_METERED_NO and NM_METERED_YES are allowed.

The device's metered state at runtime is determined by the profile which is currently active. If the profile explicitly specifies NM_METERED_NO or NM_METERED_YES, then the device's metered state is as such. If the connection profile leaves it undecided at NM_METERED_UNKNOWN (the default), then NetworkManager tries to guess the metered state, for example based on the device type or on DHCP options (like Android devices exposing a "ANDROID_METERED" DHCP vendor option). This then leads to either NM_METERED_GUESS_NO or NM_METERED_GUESS_YES.

Most applications probably should treat the runtime state NM_METERED_GUESS_YES like NM_METERED_YES, and all other states as not metered.

@@ -5319,6 +5319,145 @@
+
+
+

enum NMMptcpFlags

+

Since: 1.40

+

+
+

Values

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

NM_MPTCP_FLAGS_NONE

+

+		 +

= 0

+

+		 +

The default, meaning that no MPTCP flags are set.

+

+		 
+

NM_MPTCP_FLAGS_DISABLED

+

+		 +

= 0x1

+

+		 +

don't configure MPTCP endpoints on the device.

+

+		 
+

NM_MPTCP_FLAGS_ENABLED_ON_GLOBAL_IFACE

+

+		 +

= 0x2

+

+		 +

MPTCP handling is enabled or disabled depending on whether a /0 default route (either IPv4 or IPv6) is configured in the main routing table.

+

+		 
+

NM_MPTCP_FLAGS_ENABLED

+

+		 +

= 0x4

+

+		 +

MPTCP is enabled and endpoints will be configured. This flag is implied if any of the other flags indicate that MPTCP is enabled and therefore in most cases unnecessary.

+

+		 
+

NM_MPTCP_FLAGS_SIGNAL

+

+		 +

= 0x10

+

+		 +

Flag for the MPTCP endpoint. The endpoint will be announced/signaled to each peer via an MPTCP ADD_ADDR sub-option.

+

+		 
+

NM_MPTCP_FLAGS_SUBFLOW

+

+		 +

= 0x20

+

+		 +

Flag for the MPTCP endpoint. If additional subflow creation is allowed by the MPTCP limits, the MPTCP path manager will try to create an additional subflow using this endpoint as the source address after the MPTCP connection is established.

+

+		 
+

NM_MPTCP_FLAGS_BACKUP

+

+		 +

= 0x40

+

+		 +

Flag for the MPTCP endpoint. If this is a subflow endpoint, the subflows created using this endpoint will have the backup flag set during the connection process. This flag instructs the peer to only send data on a given subflow when all non-backup subflows are unavailable. This does not affect outgoing data, where subflow priority is determined by the backup/non-backup flag received from the peer

+

+		 
+

NM_MPTCP_FLAGS_FULLMESH

+

+		 +

= 0x80

+

+		 +

Flag for the MPTCP endpoint. If this is a subflow endpoint and additional subflow creation is allowed by the MPTCP limits, the MPTCP path manager will try to create an additional subflow for each known peer address, using this endpoint as the source address. This will occur after the MPTCP connection is established. If the peer did not announce any additional addresses using the MPTCP ADD_ADDR sub-option, this will behave the same as a plain subflow endpoint. When the peer does announce addresses, each received ADD_ADDR sub-option will trigger creation of an additional subflow to generate a full mesh topology.

+

+		 
+
+
Generated by GTK-Doc V1.33.1
diff --git a/docs/api/html/nm-initrd-generator.html b/docs/api/html/nm-initrd-generator.html index 8962d9c1..eeba0c35 100644 --- a/docs/api/html/nm-initrd-generator.html +++ b/docs/api/html/nm-initrd-generator.html @@ -102,13 +102,18 @@ ib.pkey bootdev nameserver +net.ifnames rd.peerdns +rd.iscsi.ibft rd.bootif +rd.neednet rd.ethtool rd.net.timeout.dhcp +rd.net.dhcp.retry +rd.net.dhcp.vendor-class rd.net.timeout.carrier rd.znet -rd.znet_ifnames +rd.znet_ifname BOOTIF

Please consult the dracut.cmdline(7) diff --git a/docs/api/html/nm-openvswitch.html b/docs/api/html/nm-openvswitch.html index 740989ad..d8cd6353 100644 --- a/docs/api/html/nm-openvswitch.html +++ b/docs/api/html/nm-openvswitch.html @@ -96,7 +96,7 @@

Examples

-

Example 18. Creating a Bridge with a single internal Interface

+

Example 20. Creating a Bridge with a single internal Interface

$ nmcli conn add type ovs-bridge conn.interface bridge0
 Connection 'ovs-bridge-bridge0' (d10fc64d-1d48-4394-a1b8-e1aea72f27d5) successfully added.
@@ -113,7 +113,7 @@ Connection 'ovs-interface-iface0' (3640d2a1-a2fd-4718-92f1-cffadb5b6cdc) success

-

Example 19. Adding a Linux interface to a Bridge

+

Example 21. Adding a Linux interface to a Bridge

$ nmcli conn add type ovs-port conn.interface port1 master bridge0
 Connection 'ovs-port-port1' (67d041eb-8e7b-4458-afee-a1d07c9c4552) successfully added.
@@ -124,7 +124,7 @@ Connection 'ovs-slave-eth0' (d459c45c-cf78-4c1c-b4b7-505e71379624) successfully

-

Example 20. Creating a VLAN

+

Example 22. Creating a VLAN

$ nmcli conn add type ovs-port conn.interface port2 master bridge0 ovs-port.tag 120
 Connection 'ovs-port-port2' (3994c093-4ef7-4549-a4fd-627b831c3cb8) successfully added.
@@ -135,7 +135,7 @@ Connection 'ovs-slave-eth1' (099be06e-71ad-484d-8d5a-fcadc5f207f5) successfully

-

Example 21. Creating a Bond

+

Example 23. Creating a Bond

$ nmcli conn add type ovs-port conn.interface bond0 master bridge0
 Connection 'ovs-port-bond0' (d154ebf9-e999-4e1b-a084-a3de53d25d8a) successfully added.
diff --git a/docs/api/html/nm-settings-dbus.html b/docs/api/html/nm-settings-dbus.html
index d8c9631a..f0aed252 100644
--- a/docs/api/html/nm-settings-dbus.html
+++ b/docs/api/html/nm-settings-dbus.html
@@ -95,7 +95,7 @@

connection setting

-

General Connection Profile Settings.

+

General Connection Profile Settings.

@@ -115,182 +115,262 @@ auth-retries - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + - + - + - + - + - + - + - + - + - + - + + + + + + + - + - +
int32 -1The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection. Currently, this only applies to 802-1x authentication. The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection. + + Currently, this only applies to 802-1x authentication.
autoconnect boolean TRUEWhether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection. Autoconnect happens when the circumstances are suitable. That means for example that the device is currently managed and not active. Autoconnect thus never replaces or competes with an already active profile. Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles. If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined. Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times. Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection. + + Autoconnect happens when the circumstances are suitable. That means for example that the device is currently managed and not active. Autoconnect thus never replaces or competes with an already active profile. + + Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles. + + If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined. + + Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.
autoconnect-priority int32 0The autoconnect priority in range -999 to 999. If the connection is set to autoconnect, connections with higher priority will be preferred. The higher number means higher priority. Defaults to 0. Note that this property only matters if there are more than one candidate profile to select for autoconnect. In case of equal priority, the profile used most recently is chosen. The autoconnect priority in range -999 to 999. If the connection is set to autoconnect, connections with higher priority will be preferred. The higher number means higher priority. Defaults to 0. Note that this property only matters if there are more than one candidate profile to select for autoconnect. In case of equal priority, the profile used most recently is chosen.
autoconnect-retries int32 -1The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again. The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again.
autoconnect-slaves NMSettingConnectionAutoconnectSlaves (int32)  Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0. Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0.
dns-over-tls int32 -1Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic. The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don't ever use DNSOverTls. If unspecified "default" depends on the plugin used. Systemd-resolved uses global setting. This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved. Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic. + + The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don't ever use DNSOverTls. If unspecified "default" depends on the plugin used. Systemd-resolved uses global setting. + + This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.
gateway-ping-timeout uint32 0If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping. If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.
id string  A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G". A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".
interface-name string  The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings). For software devices this specifies the name of the created device. For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface. The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings). + + For software devices this specifies the name of the created device. + + For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.
lldp int32 -1Whether LLDP is enabled for the connection. Whether LLDP is enabled for the connection.
llmnr int32 -1Whether Link-Local Multicast Name Resolution (LLMNR) is enabled for the connection. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link. The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes"). This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved. Whether Link-Local Multicast Name Resolution (LLMNR) is enabled for the connection. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link. + + The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes"). + + This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.
master string  Interface name of the master device or UUID of the master connection. Interface name of the master device or UUID of the master connection.
mdns int32 -1Whether mDNS is enabled for the connection. The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (-1) to allow lookup of a global default in NetworkManager.conf. If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "no"). This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved. Whether mDNS is enabled for the connection. + + The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (-1) to allow lookup of a global default in NetworkManager.conf. If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "no"). + + This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.
metered NMMetered (int32)  Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately. Whether the connection is metered. + + When updating this property on a currently activated connection, the change takes effect immediately.
+mptcp-flagsuint320 Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints. + + If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered. + + The flag "enabled-on-global-iface" (0x2) means that MPTCP handling is enabled if the interface configures a default route in the main routing table. This choice is per-address family, for example if there is an IPv4 default route 0.0.0.0/0, IPv4 endpoints are configured. + + The "enabled" (0x4) flag means that MPTCP handling is explicitly enabled. This flag can also be implied from the presence of other flags. + + If MPTCP handling is enabled, then endpoints will be configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags. + + If the flags are zero, the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is either "disabled" or "enabled-on-global-iface,subflow" depending on "/proc/sys/net/mptcp/enabled". + + NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp. + + Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).
mud-url string  If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer-recommended network policies for IoT devices. It is transmitted as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://". The special value "none" is allowed to indicate that no MUD URL is used. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none". If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer-recommended network policies for IoT devices. It is transmitted as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://". + + The special value "none" is allowed to indicate that no MUD URL is used. + + If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".
multi-connect int32 0Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect. Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.
permissions array of string  An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection; otherwise users are allowed if and only if they are in this list. When this is not empty, the connection can be active only when one of the specified users is logged into an active session. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8. An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection; otherwise users are allowed if and only if they are in this list. When this is not empty, the connection can be active only when one of the specified users is logged into an active session. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". + + At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.
read-only boolean FALSEFALSE if the connection can be modified using the provided settings service's D-Bus interface with the right privileges, or TRUE if the connection is read-only and cannot be modified. FALSE if the connection can be modified using the provided settings service's D-Bus interface with the right privileges, or TRUE if the connection is read-only and cannot be modified.
secondaries array of string  List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported. List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.
slave-type string  Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave. Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.
stable-id string  This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context. The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used as DHCP client identifier with ipv4.dhcp-client-id=stable and to derive the DHCP DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid]. Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key. See NetworkManager(8) manual about the secret-key and the host identity. The '$' character is treated special to perform dynamic substitutions at runtime. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-boot, or every time. Note that "${DEVICE}" corresponds to the interface name of the device and "${MAC}" is the permanent MAC address of the device. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates. If the value is unset, a global connection default is consulted. If the value is still unset, the default is similar to "${CONNECTION}" and uses a unique, fixed ID for the connection. This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context. + + The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used as DHCP client identifier with ipv4.dhcp-client-id=stable and to derive the DHCP DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid]. + + Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key. See NetworkManager(8) manual about the secret-key and the host identity. + + The '$' character is treated special to perform dynamic substitutions at runtime. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-boot, or every time. Note that "${DEVICE}" corresponds to the interface name of the device and "${MAC}" is the permanent MAC address of the device. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates. + + If the value is unset, a global connection default is consulted. If the value is still unset, the default is similar to "${CONNECTION}" and uses a unique, fixed ID for the connection.
timestamp uint64 0The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated. NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved). The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated. + + NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).
type string  Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc). Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).
uuid string  A universally unique identifier for the connection, for example generated with libuuid. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes. The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-"). A universally unique identifier for the connection, for example generated with libuuid. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes. + + The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").
+wait-activation-delayint32-1 Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event. + + The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.
wait-device-timeout int32 -1Timeout in milliseconds to wait for device at startup. During boot, devices may take a while to be detected by the driver. This property will cause to delay NetworkManager-wait-online.service and nm-online to give the device a chance to appear. This works by waiting for the given timeout until a compatible device for the profile is available and managed. The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time. Timeout in milliseconds to wait for device at startup. During boot, devices may take a while to be detected by the driver. This property will cause to delay NetworkManager-wait-online.service and nm-online to give the device a chance to appear. This works by waiting for the given timeout until a compatible device for the profile is available and managed. + + The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.
zone string  The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall. When updating this property on a currently activated connection, the change takes effect immediately. The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall. + + When updating this property on a currently activated connection, the change takes effect immediately.
@@ -298,7 +378,7 @@

6lowpan setting

-

6LoWPAN Settings.

+

6LoWPAN Settings.

@@ -317,14 +397,14 @@ parent - +
string  If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created. If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.

802-1x setting

-

IEEE 802.1x Authentication Settings.

+

IEEE 802.1x Authentication Settings.

@@ -344,329 +424,351 @@ altsubject-matches - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
array of string  List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed. List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.
anonymous-identity string  Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS. Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.
auth-timeout int32 0A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds. A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.
ca-cert byte array  Contains the CA certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory. Contains the CA certificate if used by the EAP method specified in the "eap" property. + + Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. + + Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.
ca-cert-password string  The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login. The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
ca-cert-password-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "ca-cert-password" property. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "ca-cert-password" property.
ca-path string  UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property. If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored. UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property. + + If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.
client-cert byte array  Contains the client certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. Contains the client certificate if used by the EAP method specified in the "eap" property. + + Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte.
client-cert-password string  The password used to access the client certificate stored in "client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login. The password used to access the client certificate stored in "client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
client-cert-password-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "client-cert-password" property. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "client-cert-password" property.
domain-match string  Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list. Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.
domain-suffix-match string  Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list. Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.
eap array of string  The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast". Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations. The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast". Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.
identity string  Identity string for EAP authentication methods. Often the user's user or login name. Identity string for EAP authentication methods. Often the user's user or login name.
optional boolean FALSEWhether the 802.1X authentication is optional. If TRUE, the activation will continue even after a timeout or an authentication failure. Setting the property to TRUE is currently allowed only for Ethernet connections. If set to FALSE, the activation can continue only after a successful authentication. Whether the 802.1X authentication is optional. If TRUE, the activation will continue even after a timeout or an authentication failure. Setting the property to TRUE is currently allowed only for Ethernet connections. If set to FALSE, the activation can continue only after a successful authentication.
pac-file string  UTF-8 encoded file path containing PAC for EAP-FAST. UTF-8 encoded file path containing PAC for EAP-FAST.
password string  UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred. UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.
password-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "password" property. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "password" property.
password-raw byte array  Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred. Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.
password-raw-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "password-raw" property. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "password-raw" property.
phase1-auth-flags uint32 0Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x settings. See the wpa_supplicant documentation for more details. Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x settings. See the wpa_supplicant documentation for more details.
phase1-fast-provisioning string  Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details. Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.
phase1-peaplabel string  Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details. Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.
phase1-peapver string  Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version. Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.
phase2-altsubject-matches array of string  List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed. List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.
phase2-auth string  Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified. Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.
phase2-autheap string  Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.
phase2-ca-cert byte array  Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory. Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. + + Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. + + Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.
phase2-ca-cert-password string  The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login. The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
phase2-ca-cert-password-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "phase2-ca-cert-password" property. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "phase2-ca-cert-password" property.
phase2-ca-path string  UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property. If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored. UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property. + + If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.
phase2-client-cert byte array  Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. + + Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.
phase2-client-cert-password string  The password used to access the "phase2" client certificate stored in "phase2-client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login. The password used to access the "phase2" client certificate stored in "phase2-client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
phase2-client-cert-password-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "phase2-client-cert-password" property. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "phase2-client-cert-password" property.
phase2-domain-match string  Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list. Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.
phase2-domain-suffix-match string  Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list. Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.
phase2-private-key byte array  Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". + + Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.
phase2-private-key-password string  The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS#12 format key. The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS#12 format key.
phase2-private-key-password-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "phase2-private-key-password" property. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "phase2-private-key-password" property.
phase2-subject-match string  Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2-domain-suffix-match. Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2-domain-suffix-match.
pin string  PIN used for EAP authentication methods. PIN used for EAP authentication methods.
pin-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "pin" property. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "pin" property.
private-key byte array  Contains the private key when the "eap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data. Contains the private key when the "eap" property is set to "tls". + + Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. + + WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.
private-key-password string  The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key. The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.
private-key-password-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "private-key-password" property. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "private-key-password" property.
subject-match string  Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain-suffix-match. Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain-suffix-match.
system-ca-certs boolean FALSEWhen TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant). When TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).
@@ -674,7 +776,7 @@

adsl setting

-

ADSL Settings.

+

ADSL Settings.

@@ -694,49 +796,49 @@ encapsulation - + - + - + - + - + - + - +
string  Encapsulation of ADSL connection. Can be "vcmux" or "llc". Encapsulation of ADSL connection. Can be "vcmux" or "llc".
password string  Password used to authenticate with the ADSL service. Password used to authenticate with the ADSL service.
password-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "password" property. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "password" property.
protocol string  ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm". ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".
username string  Username used to authenticate with the ADSL service. Username used to authenticate with the ADSL service.
vci uint32 0VCI of ADSL connection VCI of ADSL connection
vpi uint32 0VPI of ADSL connection VPI of ADSL connection
@@ -744,7 +846,7 @@

bluetooth setting

-

Bluetooth Settings.

+

Bluetooth Settings.

@@ -764,14 +866,14 @@ bdaddr - + - +
byte array  The Bluetooth address of the device. The Bluetooth address of the device.
type string  Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile. Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.
@@ -779,7 +881,7 @@

bond setting

-

Bonding Settings.

+

Bonding Settings.

@@ -806,7 +908,7 @@ options - +
dict of string to string {'mode': 'balance-rr'}Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]). Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).
@@ -814,7 +916,7 @@

bridge setting

-

Bridging Settings.

+

Bridging Settings.

@@ -834,35 +936,37 @@ ageing-time - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
uint32 300The Ethernet MAC address aging time, in seconds. The Ethernet MAC address aging time, in seconds.
forward-delay uint32 15The Spanning Tree Protocol (STP) forwarding delay, in seconds. The Spanning Tree Protocol (STP) forwarding delay, in seconds.
group-address byte array  If specified, The MAC address of the multicast group this bridge uses for STP. The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00. If specified, The MAC address of the multicast group this bridge uses for STP. + + The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00.
group-forward-mask uint32 0A mask of group addresses to forward. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can't have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP. A mask of group addresses to forward. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can't have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP.
hello-time uint32 2The Spanning Tree Protocol (STP) hello time, in seconds. The Spanning Tree Protocol (STP) hello time, in seconds.
@@ -876,154 +980,166 @@ mac-address byte array  If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge. Hence, this property is deprecated. Deprecated: 1 If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. + + If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge. Hence, this property is deprecated. Deprecated: 1
max-age uint32 20The Spanning Tree Protocol (STP) maximum message age, in seconds. The Spanning Tree Protocol (STP) maximum message age, in seconds.
multicast-hash-max uint32 4096Set maximum size of multicast hash table (value must be a power of 2). Set maximum size of multicast hash table (value must be a power of 2).
multicast-last-member-count uint32 2Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received. Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.
multicast-last-member-interval uint64 100Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received. Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.
multicast-membership-interval uint64 26000Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received. Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.
multicast-querier boolean FALSEEnable or disable sending of multicast queries by the bridge. If not specified the option is disabled. Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.
multicast-querier-interval uint64 25500If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries. If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.
multicast-query-interval uint64 12500Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase. Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.
multicast-query-response-interval uint64 1000Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge. Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.
multicast-query-use-ifaddr boolean FALSEIf enabled the bridge's own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used. If enabled the bridge's own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used.
multicast-router string  Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work. Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1). Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work. + + Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).
multicast-snooping boolean TRUEControls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved. Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.
multicast-startup-query-count uint32 2Set the number of IGMP queries to send during startup phase. Set the number of IGMP queries to send during startup phase.
multicast-startup-query-interval uint64 3125Sets the time (in deciseconds) between queries sent out at startup to determine membership information. Sets the time (in deciseconds) between queries sent out at startup to determine membership information.
priority uint32 32768Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge. Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.
stp boolean TRUEControls whether Spanning Tree Protocol (STP) is enabled for this bridge. Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.
vlan-default-pvid uint32 1The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames. The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.
vlan-filtering boolean FALSEControl whether VLAN filtering is enabled on the bridge. Control whether VLAN filtering is enabled on the bridge.
vlan-protocol string  If specified, the protocol used for VLAN filtering. Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'. If specified, the protocol used for VLAN filtering. + + Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.
vlan-stats-enabled boolean FALSEControls whether per-VLAN stats accounting is enabled. Controls whether per-VLAN stats accounting is enabled.
vlans array of vardict  Array of bridge VLAN objects. In addition to the VLANs specified here, the bridge will also have the default-pvid VLAN configured by the bridge.vlan-default-pvid property. In nmcli the VLAN list can be specified with the following syntax: $vid [pvid] [untagged] [, $vid [pvid] [untagged]]... where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash. Array of bridge VLAN objects. In addition to the VLANs specified here, the bridge will also have the default-pvid VLAN configured by the bridge.vlan-default-pvid property. + + In nmcli the VLAN list can be specified with the following syntax: + + $vid [pvid] [untagged] [, $vid [pvid] [untagged]]... + + where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.
@@ -1031,7 +1147,7 @@

bridge-port setting

-

Bridge Port Settings.

+

Bridge Port Settings.

@@ -1051,28 +1167,34 @@ hairpin-mode - + - + - + - +
boolean FALSEEnables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on. Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.
path-cost uint32 100The Spanning Tree Protocol (STP) port cost for destinations via this port. The Spanning Tree Protocol (STP) port cost for destinations via this port.
priority uint32 32The Spanning Tree Protocol (STP) priority of this bridge port. The Spanning Tree Protocol (STP) priority of this bridge port.
vlans array of vardict  Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property. In nmcli the VLAN list can be specified with the following syntax: $vid [pvid] [untagged] [, $vid [pvid] [untagged]]... where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash. Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property. + + In nmcli the VLAN list can be specified with the following syntax: + + $vid [pvid] [untagged] [, $vid [pvid] [untagged]]... + + where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.
@@ -1080,7 +1202,7 @@

cdma setting

-

CDMA-based Mobile Broadband Settings.

+

CDMA-based Mobile Broadband Settings.

@@ -1100,35 +1222,35 @@ mtu - + - + - + - + - +
uint32 0If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames. If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.
number string  The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required. The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required.
password string  The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here. The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.
password-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "password" property. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "password" property.
username string  The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here. The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.
@@ -1136,7 +1258,7 @@

dcb setting

-

Data Center Bridging Settings.

+

Data Center Bridging Settings.

@@ -1156,105 +1278,107 @@ app-fcoe-flags - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
NMSettingDcbFlags (uint32)  Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4). Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).
app-fcoe-mode string  The FCoE controller mode; either "fabric" or "vn2vn". Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric". The FCoE controller mode; either "fabric" or "vn2vn". + + Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".
app-fcoe-priority int32 -1The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag. The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.
app-fip-flags NMSettingDcbFlags (uint32)  Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4). Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).
app-fip-priority int32 -1The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag. The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.
app-iscsi-flags NMSettingDcbFlags (uint32)  Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4). Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).
app-iscsi-priority int32 -1The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag. The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.
priority-bandwidth array of uint32  An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents. An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents.
priority-flow-control array of uint32  An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause. An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.
priority-flow-control-flags NMSettingDcbFlags (uint32)  Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4). Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).
priority-group-bandwidth array of uint32  An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percents. An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percents.
priority-group-flags NMSettingDcbFlags (uint32)  Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4). Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).
priority-group-id array of uint32  An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group. An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.
priority-strict-bandwidth array of uint32  An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group. An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.
priority-traffic-class array of uint32  An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped. An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.
@@ -1262,7 +1386,7 @@

dummy setting

-

Dummy Link Settings.

+

Dummy Link Settings.

@@ -1282,7 +1406,7 @@

ethtool setting

-

Ethtool Ethernet Settings.

+

Ethtool Ethernet Settings.

@@ -1302,7 +1426,7 @@

generic setting

-

Generic Link Settings.

+

Generic Link Settings.

@@ -1322,7 +1446,7 @@

gsm setting

-

GSM-based Mobile Broadband Settings.

+

GSM-based Mobile Broadband Settings.

@@ -1342,98 +1466,98 @@ apn - + - + - + - + - + - + - + - + - + - + - + - + - + - +
string  The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9. The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.
auto-config boolean FALSEWhen TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database. When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.
device-id string  The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device. The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.
home-only boolean FALSEWhen TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made. When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.
mtu uint32 0If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames. If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.
network-id string  The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible. The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.
number string  Legacy setting that used to help establishing PPP data sessions for GSM-based modems. Deprecated: 1 Legacy setting that used to help establishing PPP data sessions for GSM-based modems. Deprecated: 1
password string  The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here. The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.
password-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "password" property. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "password" property.
pin string  If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device. If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.
pin-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "pin" property. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "pin" property.
sim-id string  The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier. The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.
sim-operator-id string  A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator. A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.
username string  The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here. The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.
@@ -1441,7 +1565,7 @@

infiniband setting

-

Infiniband Settings.

+

Infiniband Settings.

@@ -1461,35 +1585,35 @@ mac-address - + - + - + - + - +
byte array  If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing). If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).
mtu uint32 0If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames. If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.
p-key int32 -1The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key. The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key.
parent string  The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address". The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".
transport-mode string  The IP-over-InfiniBand transport mode. Either "datagram" or "connected". The IP-over-InfiniBand transport mode. Either "datagram" or "connected".
@@ -1497,7 +1621,7 @@

ipv4 setting

-

IPv4 Settings.

+

IPv4 Settings.

@@ -1531,70 +1655,94 @@ dad-timeout - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + - + - + - + - + - + - + Allowed values: yes,no,opportunistic + + + + + + @@ -1163,6 +1172,17 @@ Example: https://yourdevice.example.com/model.jsonwait-activation-delay + + + +
int32 -1Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds. The property is currently implemented only for IPv4. Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds. + + The property is currently implemented only for IPv4.
dhcp-client-id string  A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0. The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links. The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset. The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id. The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key. If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin. A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0. + + The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links. + + The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset. + + The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id. + + The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key. + + If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin.
dhcp-fqdn string  If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time. If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.
dhcp-hostname string  If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time. If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.
dhcp-hostname-flags uint32 0Flags for the DHCP hostname and FQDN. Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests. Flags for the DHCP hostname and FQDN. + + Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. + + When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.
dhcp-iaid string  A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address. A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.
dhcp-reject-servers array of string  Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). This property is currently not implemented for DHCPv6. Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. + + For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). + + This property is currently not implemented for DHCPv6.
dhcp-send-hostname boolean TRUEIf TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent. If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.
dhcp-timeout int32 0A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). Set to 2147483647 (MAXINT32) for infinity. A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). + + Set to 2147483647 (MAXINT32) for infinity.
dhcp-vendor-class-identifier string  The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server. Since 1.28 The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server. + + Since 1.28
@@ -1608,70 +1756,125 @@ dns-options array of string  Array of DNS options as described in man 5 resolv.conf. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties. The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added. Array of DNS options as described in man 5 resolv.conf. + + NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties. + + The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". + + The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. + + When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.
dns-priority int32 0DNS servers priority. The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections. Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured. DNS servers priority. + + The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). + + Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. + + Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections. + + Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. + + When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. + + When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. + + When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.
dns-search array of string  Array of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names. When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting. List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names. + + When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting. + + When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).
gateway string  The gateway associated with this configuration. This is only meaningful if "addresses" is also set. The gateway's main purpose is to control the next hop of the standard default route on the device. Hence, the gateway property conflicts with "never-default" and will be automatically dropped if the IP configuration is set to never-default. As an alternative to set the gateway, configure a static default route with /0 as prefix length. The gateway associated with this configuration. This is only meaningful if "addresses" is also set. + + The gateway's main purpose is to control the next hop of the standard default route on the device. Hence, the gateway property conflicts with "never-default" and will be automatically dropped if the IP configuration is set to never-default. + + As an alternative to set the gateway, configure a static default route with /0 as prefix length.
ignore-auto-dns boolean FALSEWhen "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used. When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.
ignore-auto-routes boolean FALSEWhen "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used. When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.
+link-localint320 Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server. + + When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default". + + Since 1.40
may-fail boolean TRUEIf TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully. If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.
method string  IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared. IP configuration method. + + NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. + + In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. + + For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. + + For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.
never-default boolean FALSEIf TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager. If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.
required-timeout int32 -1The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero). The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. + + This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. + + Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. + + A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).
@@ -1685,14 +1888,20 @@ route-metric int64 -1The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric. The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.
route-table uint32 0Enable policy routing (source routing) and set the routing table used when adding routes. This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager. Enable policy routing (source routing) and set the routing table used when adding routes. + + This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. + + If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. + + Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.
@@ -1707,7 +1916,7 @@

ipv6 setting

-

IPv6 Settings.

+

IPv6 Settings.

@@ -1726,8 +1935,18 @@ - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + - + - + - + - + - + - + - +
addr-gen-mode int321Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced. The value of stable-privacy enables use of cryptographically secure hash of a secret host-specific key along with the connection's stable-id and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced. On D-Bus, the absence of an addr-gen-mode setting equals enabling stable-privacy. For keyfile plugin, the absence of the setting on disk means EUI64 so that the property doesn't change on upgrade from older versions. Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.3 Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3). + + If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced. + + The value of stable-privacy enables use of cryptographically secure hash of a secret host-specific key along with the connection's stable-id and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced. + + The special values "default" and "default-or-eui64" will fallback to the global connection default in as documented in NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively. + + For libnm, the property defaults to "default" since 1.40. Previously it defaulted to "stable-privacy". On D-Bus, the absence of an addr-gen-mode setting equals "default". For keyfile plugin, the absence of the setting on disk means "default-or-eui64" so that the property doesn't change on upgrade from older versions. + + Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.
@@ -1741,63 +1960,83 @@ addresses array of legacy IPv6 address struct (a(ayuay))  Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. Array of IPv6 address structures. Each IPv6 address structure is composed of an IPv6 address, a prefix length (1 - 128), and an IPv6 gateway address. The gateway may be zeroed out if no gateway exists for that subnet.Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. Array of IPv6 address structures. Each IPv6 address structure is composed of an IPv6 address, a prefix length (0 - 128), and an IPv6 gateway address. The gateway may be zeroed out if no gateway exists for that subnet.
dad-timeout int32 -1Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds. The property is currently implemented only for IPv4. Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds. + + The property is currently implemented only for IPv4.
dhcp-duid string  A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option. The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id. The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk. The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt"). When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed. A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option. + + The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id. + + The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk. + + The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt"). + + When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.
dhcp-hostname string  If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time. If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.
dhcp-hostname-flags uint32 0Flags for the DHCP hostname and FQDN. Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests. Flags for the DHCP hostname and FQDN. + + Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. + + When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.
dhcp-iaid string  A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address. A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.
dhcp-reject-servers array of string  Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). This property is currently not implemented for DHCPv6. Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. + + For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). + + This property is currently not implemented for DHCPv6.
dhcp-send-hostname boolean TRUEIf TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent. If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.
dhcp-timeout int32 0A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). Set to 2147483647 (MAXINT32) for infinity. A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). + + Set to 2147483647 (MAXINT32) for infinity.
@@ -1811,84 +2050,143 @@ dns-options array of string  Array of DNS options as described in man 5 resolv.conf. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties. The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added. Array of DNS options as described in man 5 resolv.conf. + + NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties. + + The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". + + The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. + + When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.
dns-priority int32 0DNS servers priority. The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections. Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured. DNS servers priority. + + The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). + + Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. + + Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections. + + Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. + + When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. + + When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. + + When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.
dns-search array of string  Array of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names. When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting. List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names. + + When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting. + + When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).
gateway string  The gateway associated with this configuration. This is only meaningful if "addresses" is also set. The gateway's main purpose is to control the next hop of the standard default route on the device. Hence, the gateway property conflicts with "never-default" and will be automatically dropped if the IP configuration is set to never-default. As an alternative to set the gateway, configure a static default route with /0 as prefix length. The gateway associated with this configuration. This is only meaningful if "addresses" is also set. + + The gateway's main purpose is to control the next hop of the standard default route on the device. Hence, the gateway property conflicts with "never-default" and will be automatically dropped if the IP configuration is set to never-default. + + As an alternative to set the gateway, configure a static default route with /0 as prefix length.
ignore-auto-dns boolean FALSEWhen "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used. When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.
ignore-auto-routes boolean FALSEWhen "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used. When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.
ip6-privacy NMSettingIP6ConfigPrivacy (int32)  Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses). Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy". If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr". Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses. Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses). + + Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy". + + If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr". + + Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.
may-fail boolean TRUEIf TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully. If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.
method string  IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared. IP configuration method. + + NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. + + In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. + + For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. + + For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.
+mtuuint320 Maximum transmission unit size, in bytes. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link-layer MTU. If greater than the link-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect.
never-default boolean FALSEIf TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager. If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.
ra-timeout int32 0A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device. Set to 2147483647 (MAXINT32) for infinity. A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device. + + Set to 2147483647 (MAXINT32) for infinity.
required-timeout int32 -1The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero). The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. + + This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. + + Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. + + A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).
@@ -1902,28 +2200,34 @@ route-metric int64 -1The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric. The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.
route-table uint32 0Enable policy routing (source routing) and set the routing table used when adding routes. This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager. Enable policy routing (source routing) and set the routing table used when adding routes. + + This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. + + If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. + + Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.
routes array of legacy IPv6 route struct (a(ayuayu))  Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. Array of IPv6 route structures. Each IPv6 route structure is composed of an IPv6 address, a prefix length (1 - 128), an IPv6 next hop address (which may be zeroed out if there is no next hop), and a metric. If the metric is 0, NM will choose an appropriate default metric for the device.Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. Array of IPv6 route structures. Each IPv6 route structure is composed of an IPv6 address, a prefix length (0 - 128), an IPv6 next hop address (which may be zeroed out if there is no next hop), and a metric. If the metric is 0, NM will choose an appropriate default metric for the device.
token string  Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode. Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.
@@ -1931,7 +2235,7 @@

ip-tunnel setting

-

IP Tunneling Settings.

+

IP Tunneling Settings.

@@ -1951,91 +2255,91 @@ encapsulation-limit - + - + - + - + - + - + - + - + - + - + - + - + - +
uint32 0How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.
flags uint32 0Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels. Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.
flow-label uint32 0The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels. The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.
input-key string  The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used. The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.
local string  The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address. The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.
mode uint32 0The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2). The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).
mtu uint32 0If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments. If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.
output-key string  The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used. The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.
parent string  If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface. If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.
path-mtu-discovery boolean TRUEWhether to enable Path MTU Discovery on this tunnel. Whether to enable Path MTU Discovery on this tunnel.
remote string  The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address. The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.
tos uint32 0The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets. The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.
ttl uint32 0The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value. The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.
@@ -2043,7 +2347,7 @@

macsec setting

-

MACSec Settings.

+

MACSec Settings.

@@ -2063,63 +2367,63 @@ encrypt - + - + - + - + - + - + - + - + - +
boolean TRUEWhether the transmitted traffic must be encrypted. Whether the transmitted traffic must be encrypted.
mka-cak string  The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement.
mka-cak-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "mka-cak" property. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "mka-cak" property.
mka-ckn string  The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement.
mode int32 0Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained. Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.
parent string  If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property. If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.
port int32 1The port component of the SCI (Secure Channel Identifier), between 1 and 65534. The port component of the SCI (Secure Channel Identifier), between 1 and 65534.
send-sci boolean TRUESpecifies whether the SCI (Secure Channel Identifier) is included in every packet. Specifies whether the SCI (Secure Channel Identifier) is included in every packet.
validation int32 2Specifies the validation mode for incoming frames. Specifies the validation mode for incoming frames.
@@ -2127,7 +2431,7 @@

macvlan setting

-

MAC VLAN Settings.

+

MAC VLAN Settings.

@@ -2147,28 +2451,28 @@ mode - + - + - + - +
uint32 0The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device. The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.
parent string  If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property. If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.
promiscuous boolean TRUEWhether the interface should be put in promiscuous mode. Whether the interface should be put in promiscuous mode.
tap boolean FALSEWhether the interface should be a MACVTAP. Whether the interface should be a MACVTAP.
@@ -2176,7 +2480,7 @@

match setting

-

Match settings.

+

Match settings.

@@ -2196,28 +2500,42 @@ driver - + - + - + - +
array of string  A list of driver names to match. Each element is a shell wildcard pattern. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern. A list of driver names to match. Each element is a shell wildcard pattern. + + See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.
interface-name array of string  A list of interface names to match. Each element is a shell wildcard pattern. An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a". A list of interface names to match. Each element is a shell wildcard pattern. + + An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".
kernel-command-line array of string  A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match. A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported. + + See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.
path array of string  A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier. For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0". The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev"). Each element of the list is a shell wildcard pattern. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern. A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier. + + For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0". + + The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev"). + + Each element of the list is a shell wildcard pattern. + + See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.
@@ -2225,7 +2543,7 @@

802-11-olpc-mesh setting

-

OLPC Wireless Mesh Settings.

+

OLPC Wireless Mesh Settings.

@@ -2245,21 +2563,23 @@ channel - + - + - +
uint32 0Channel on which the mesh network to join is located. Channel on which the mesh network to join is located.
dhcp-anycast-address byte array  Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request. This is currently only implemented by dhclient DHCP plugin. Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request. + + This is currently only implemented by dhclient DHCP plugin.
ssid byte array  SSID of the mesh network to join. SSID of the mesh network to join.
@@ -2267,7 +2587,7 @@

ovs-bridge setting

-

OvsBridge Link Settings.

+

OvsBridge Link Settings.

@@ -2287,35 +2607,35 @@ datapath-type - + - + - + - + - +
string  The data path type. One of "system", "netdev" or empty. The data path type. One of "system", "netdev" or empty.
fail-mode string  The bridge failure mode. One of "secure", "standalone" or empty. The bridge failure mode. One of "secure", "standalone" or empty.
mcast-snooping-enable boolean FALSEEnable or disable multicast snooping. Enable or disable multicast snooping.
rstp-enable boolean FALSEEnable or disable RSTP. Enable or disable RSTP.
stp-enable boolean FALSEEnable or disable STP. Enable or disable STP.
@@ -2323,7 +2643,7 @@

ovs-dpdk setting

-

OvsDpdk Link Settings.

+

OvsDpdk Link Settings.

@@ -2343,14 +2663,14 @@ devargs - + - +
string  Open vSwitch DPDK device arguments. Open vSwitch DPDK device arguments.
n-rxq uint32 0Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue. Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.
@@ -2358,7 +2678,7 @@

ovs-interface setting

-

Open vSwitch Interface Settings.

+

Open vSwitch Interface Settings.

@@ -2377,14 +2697,14 @@ type - +
string  The interface type. Either "internal", "system", "patch", "dpdk", or empty. The interface type. Either "internal", "system", "patch", "dpdk", or empty.

ovs-patch setting

-

OvsPatch Link Settings.

+

OvsPatch Link Settings.

@@ -2403,14 +2723,14 @@ peer - +
string  Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer. Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.

ovs-port setting

-

OvsPort Link Settings.

+

OvsPort Link Settings.

@@ -2430,42 +2750,42 @@ bond-downdelay - + - + - + - + - + - +
uint32 0The time port must be inactive in order to be considered down. The time port must be inactive in order to be considered down.
bond-mode string  Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp". Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".
bond-updelay uint32 0The time port must be active before it starts forwarding traffic. The time port must be active before it starts forwarding traffic.
lacp string  LACP mode. One of "active", "off", or "passive". LACP mode. One of "active", "off", or "passive".
tag uint32 0The VLAN tag in the range 0-4095. The VLAN tag in the range 0-4095.
vlan-mode string  The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk" or unset. The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk" or unset.
@@ -2473,7 +2793,7 @@

ppp setting

-

Point-to-Point Protocol Settings.

+

Point-to-Point Protocol Settings.

@@ -2493,126 +2813,126 @@ baud - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
uint32 0If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed. If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.
crtscts boolean FALSEIf TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE. If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.
lcp-echo-failure uint32 0If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used. If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.
lcp-echo-interval uint32 0If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this. If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.
mppe-stateful boolean FALSEIf TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE. If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.
mru uint32 0If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384. If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.
mtu uint32 0If non-zero, instruct pppd to send packets no larger than the specified size. If non-zero, instruct pppd to send packets no larger than the specified size.
no-vj-comp boolean FALSEIf TRUE, Van Jacobsen TCP header compression will not be requested. If TRUE, Van Jacobsen TCP header compression will not be requested.
noauth boolean TRUEIf TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE. If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.
nobsdcomp boolean FALSEIf TRUE, BSD compression will not be requested. If TRUE, BSD compression will not be requested.
nodeflate boolean FALSEIf TRUE, "deflate" compression will not be requested. If TRUE, "deflate" compression will not be requested.
refuse-chap boolean FALSEIf TRUE, the CHAP authentication method will not be used. If TRUE, the CHAP authentication method will not be used.
refuse-eap boolean FALSEIf TRUE, the EAP authentication method will not be used. If TRUE, the EAP authentication method will not be used.
refuse-mschap boolean FALSEIf TRUE, the MSCHAP authentication method will not be used. If TRUE, the MSCHAP authentication method will not be used.
refuse-mschapv2 boolean FALSEIf TRUE, the MSCHAPv2 authentication method will not be used. If TRUE, the MSCHAPv2 authentication method will not be used.
refuse-pap boolean FALSEIf TRUE, the PAP authentication method will not be used. If TRUE, the PAP authentication method will not be used.
require-mppe boolean FALSEIf TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections. If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.
require-mppe-128 boolean FALSEIf TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail. If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.
@@ -2620,7 +2940,7 @@

pppoe setting

-

PPP-over-Ethernet Settings.

+

PPP-over-Ethernet Settings.

@@ -2640,35 +2960,35 @@ parent - + - + - + - + - +
string  If given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection. If given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.
password string  Password used to authenticate with the PPPoE service. Password used to authenticate with the PPPoE service.
password-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "password" property. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "password" property.
service string  If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required. If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.
username string  Username used to authenticate with the PPPoE service. Username used to authenticate with the PPPoE service.
@@ -2676,7 +2996,7 @@

proxy setting

-

WWW Proxy Settings.

+

WWW Proxy Settings.

@@ -2696,28 +3016,28 @@ browser-only - + - + - + - +
boolean FALSEWhether the proxy configuration is for browser only. Whether the proxy configuration is for browser only.
method int32 0Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0) Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)
pac-script string  PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function. PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.
pac-url string  PAC URL for obtaining PAC file. PAC URL for obtaining PAC file.
@@ -2725,7 +3045,7 @@

serial setting

-

Serial Link Settings.

+

Serial Link Settings.

@@ -2745,14 +3065,14 @@ baud - + - + - + - +
uint32 57600Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed. Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.
bits uint32 8Byte-width of the serial communication. The 8 in "8n1" for example. Byte-width of the serial communication. The 8 in "8n1" for example.
@@ -2766,14 +3086,14 @@ send-delay uint64 0Time to delay between each byte sent to the modem, in microseconds. Time to delay between each byte sent to the modem, in microseconds.
stopbits uint32 1Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example. Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.
@@ -2781,7 +3101,7 @@

sriov setting

-

SR-IOV settings.

+

SR-IOV settings.

@@ -2801,21 +3121,47 @@ autoprobe-drivers - + - + - +
NMTernary (int32)  Whether to autoprobe virtual functions by a compatible driver. If set to NM_TERNARY_TRUE (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF. If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them. When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_TRUE (1). Whether to autoprobe virtual functions by a compatible driver. + + If set to NM_TERNARY_TRUE (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF. + + If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them. + + When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_TRUE (1).
total-vfs uint32 0The total number of virtual functions to create. Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection. The total number of virtual functions to create. + + Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.
vfs array of vardict  Array of virtual function descriptors. Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF. When represented as string a VF is in the form: "INDEX [ATTR=VALUE[ ATTR=VALUE]...]". for example: "2 mac=00:11:22:33:44:55 spoof-check=true". Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans. The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form "ID[.PRIORITY[.PROTO]]". PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad. Array of virtual function descriptors. + + Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF. + + When represented as string a VF is in the form: + + "INDEX [ATTR=VALUE[ ATTR=VALUE]...]". + + for example: + + "2 mac=00:11:22:33:44:55 spoof-check=true". + + Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans. + + The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form + + "ID[.PRIORITY[.PROTO]]". + + PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.
@@ -2823,7 +3169,7 @@

tc setting

-

Linux Traffic Control Settings.

+

Linux Traffic Control Settings.

@@ -2843,14 +3189,22 @@ qdiscs - + - +
array of vardict  Array of TC queueing disciplines. When the "tc" setting is present, qdiscs from this property are applied upon activation. If the property is empty, all qdiscs are removed and the device will only have the default qdisc assigned by kernel according to the "net.core.default_qdisc" sysctl. If the "tc" setting is not present, NetworkManager doesn't touch the qdiscs present on the interface. Array of TC queueing disciplines. + + When the "tc" setting is present, qdiscs from this property are applied upon activation. If the property is empty, all qdiscs are removed and the device will only have the default qdisc assigned by kernel according to the "net.core.default_qdisc" sysctl. + + If the "tc" setting is not present, NetworkManager doesn't touch the qdiscs present on the interface.
tfilters array of vardict  Array of TC traffic filters. When the "tc" setting is present, filters from this property are applied upon activation. If the property is empty, NetworkManager removes all the filters. If the "tc" setting is not present, NetworkManager doesn't touch the filters present on the interface. Array of TC traffic filters. + + When the "tc" setting is present, filters from this property are applied upon activation. If the property is empty, NetworkManager removes all the filters. + + If the "tc" setting is not present, NetworkManager doesn't touch the filters present on the interface.
@@ -2858,7 +3212,7 @@

team setting

-

Teaming Settings.

+

Teaming Settings.

@@ -2878,7 +3232,7 @@ config - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
string  The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details. The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.
@@ -2892,105 +3246,105 @@ link-watchers array of vardict  Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details. Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.
mcast-rejoin-count int32 -1Corresponds to the teamd mcast_rejoin.count. Corresponds to the teamd mcast_rejoin.count.
mcast-rejoin-interval int32 -1Corresponds to the teamd mcast_rejoin.interval. Corresponds to the teamd mcast_rejoin.interval.
notify-peers-count int32 -1Corresponds to the teamd notify_peers.count. Corresponds to the teamd notify_peers.count.
notify-peers-interval int32 -1Corresponds to the teamd notify_peers.interval. Corresponds to the teamd notify_peers.interval.
runner string  Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random". Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".
runner-active boolean TRUECorresponds to the teamd runner.active. Corresponds to the teamd runner.active.
runner-agg-select-policy string  Corresponds to the teamd runner.agg_select_policy. Corresponds to the teamd runner.agg_select_policy.
runner-fast-rate boolean FALSECorresponds to the teamd runner.fast_rate. Corresponds to the teamd runner.fast_rate.
runner-hwaddr-policy string  Corresponds to the teamd runner.hwaddr_policy. Corresponds to the teamd runner.hwaddr_policy.
runner-min-ports int32 -1Corresponds to the teamd runner.min_ports. Corresponds to the teamd runner.min_ports.
runner-sys-prio int32 -1Corresponds to the teamd runner.sys_prio. Corresponds to the teamd runner.sys_prio.
runner-tx-balancer string  Corresponds to the teamd runner.tx_balancer.name. Corresponds to the teamd runner.tx_balancer.name.
runner-tx-balancer-interval int32 -1Corresponds to the teamd runner.tx_balancer.interval. Corresponds to the teamd runner.tx_balancer.interval.
runner-tx-hash array of string  Corresponds to the teamd runner.tx_hash. Corresponds to the teamd runner.tx_hash.
@@ -2998,7 +3352,7 @@

team-port setting

-

Team Port Settings.

+

Team Port Settings.

@@ -3018,49 +3372,49 @@ config - + - + - + - + - + - + - +
string  The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details. The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.
lacp-key int32 -1Corresponds to the teamd ports.PORTIFNAME.lacp_key. Corresponds to the teamd ports.PORTIFNAME.lacp_key.
lacp-prio int32 -1Corresponds to the teamd ports.PORTIFNAME.lacp_prio. Corresponds to the teamd ports.PORTIFNAME.lacp_prio.
link-watchers array of vardict  Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details. Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.
prio int32 0Corresponds to the teamd ports.PORTIFNAME.prio. Corresponds to the teamd ports.PORTIFNAME.prio.
queue-id int32 -1Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config. Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.
sticky boolean FALSECorresponds to the teamd ports.PORTIFNAME.sticky. Corresponds to the teamd ports.PORTIFNAME.sticky.
@@ -3068,7 +3422,7 @@

tun setting

-

Tunnel Settings.

+

Tunnel Settings.

@@ -3088,42 +3442,42 @@ group - + - + - + - + - + - +
string  The group ID which will own the device. If set to NULL everyone will be able to use the device. The group ID which will own the device. If set to NULL everyone will be able to use the device.
mode uint32 1The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one. The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.
multi-queue boolean FALSEIf the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue. If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.
owner string  The user ID which will own the device. If set to NULL everyone will be able to use the device. The user ID which will own the device. If set to NULL everyone will be able to use the device.
pi boolean FALSEIf TRUE the interface will prepend a 4 byte header describing the physical interface to the packets. If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.
vnet-hdr boolean FALSEIf TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header. If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.
@@ -3131,7 +3485,7 @@

user setting

-

General User Profile Settings.

+

General User Profile Settings.

@@ -3150,14 +3504,14 @@ data - +
dict of string to string {}A dictionary of key/value pairs with user data. This data is ignored by NetworkManager and can be used at the users discretion. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length. A dictionary of key/value pairs with user data. This data is ignored by NetworkManager and can be used at the users discretion. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length.

vlan setting

-

VLAN Settings.

+

VLAN Settings.

@@ -3177,28 +3531,30 @@ egress-priority-map - + - + - + - + - +
array of string  For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3". For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".
flags NMVlanFlags (uint32)  One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol). The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0. One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol). + + The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.
id uint32 0The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095. The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.
ingress-priority-map array of string  For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3". For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".
@@ -3212,7 +3568,7 @@ parent string  If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property. If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.
@@ -3220,7 +3576,7 @@

vpn setting

-

VPN Settings.

+

VPN Settings.

@@ -3240,42 +3596,42 @@ data - + - + - + - + - + - +
dict of string to string {}Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings. Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.
persistent boolean FALSEIf the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected. If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.
secrets dict of string to string {}Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings. Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.
service-type string  D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin. D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.
timeout uint32 0Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overridden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds. Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overridden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.
user-name string  If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection. If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.
@@ -3283,7 +3639,7 @@

vrf setting

-

VRF settings.

+

VRF settings.

@@ -3302,14 +3658,14 @@ table - +
uint32 0The routing table for this VRF. The routing table for this VRF.

vxlan setting

-

VXLAN Settings.

+

VXLAN Settings.

@@ -3329,112 +3685,112 @@ ageing - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
uint32 300Specifies the lifetime in seconds of FDB entries learnt by the kernel. Specifies the lifetime in seconds of FDB entries learnt by the kernel.
destination-port uint32 8472Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint. Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.
id uint32 0Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use. Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.
l2-miss boolean FALSESpecifies whether netlink LL ADDR miss notifications are generated. Specifies whether netlink LL ADDR miss notifications are generated.
l3-miss boolean FALSESpecifies whether netlink IP ADDR miss notifications are generated. Specifies whether netlink IP ADDR miss notifications are generated.
learning boolean TRUESpecifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database. Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.
limit uint32 0Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries. Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.
local string  If given, specifies the source IP address to use in outgoing packets. If given, specifies the source IP address to use in outgoing packets.
parent string  If given, specifies the parent interface name or parent connection UUID. If given, specifies the parent interface name or parent connection UUID.
proxy boolean FALSESpecifies whether ARP proxy is turned on. Specifies whether ARP proxy is turned on.
remote string  Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join. Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.
rsc boolean FALSESpecifies whether route short circuit is turned on. Specifies whether route short circuit is turned on.
source-port-max uint32 0Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint. Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.
source-port-min uint32 0Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint. Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.
tos uint32 0Specifies the TOS value to use in outgoing packets. Specifies the TOS value to use in outgoing packets.
ttl uint32 0Specifies the time-to-live value to use in outgoing packets. Specifies the time-to-live value to use in outgoing packets.
@@ -3442,7 +3798,7 @@

wifi-p2p setting

-

Wi-Fi P2P Settings.

+

Wi-Fi P2P Settings.

@@ -3462,21 +3818,25 @@ peer - + - + - +
string  The P2P device that should be connected to. Currently, this is the only way to create or join a group. The P2P device that should be connected to. Currently, this is the only way to create or join a group.
wfd-ies byte array  The Wi-Fi Display (WFD) Information Elements (IEs) to set. Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client. The Wi-Fi Display (WFD) Information Elements (IEs) to set. + + Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.
wps-method uint32 0Flags indicating which mode of WPS is to be used. There's little point in changing the default setting as NetworkManager will automatically determine the best method to use. Flags indicating which mode of WPS is to be used. + + There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.
@@ -3484,7 +3844,7 @@

wimax setting

-

WiMax Settings.

+

WiMax Settings.

@@ -3504,14 +3864,14 @@ mac-address - + - +
byte array  If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing). Deprecated: 1 If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing). Deprecated: 1
network-name string  Network Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1 Network Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1
@@ -3519,7 +3879,7 @@

802-3-ethernet setting

-

Wired Ethernet Settings.

+

Wired Ethernet Settings.

@@ -3539,7 +3899,7 @@ accept-all-mac-addresses - + - + - + - + - + - + - + - + - + - + - + - + - + - +
NMTernary (int32)  When TRUE, setup the interface to accept packets for all MAC addresses. This is enabling the kernel interface flag IFF_PROMISC. When FALSE, the interface will only accept the packets with the interface destination mac address or broadcast. When TRUE, setup the interface to accept packets for all MAC addresses. This is enabling the kernel interface flag IFF_PROMISC. When FALSE, the interface will only accept the packets with the interface destination mac address or broadcast.
@@ -3553,7 +3913,7 @@ auto-negotiate boolean FALSEWhen TRUE, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped. When TRUE, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped.
@@ -3567,84 +3927,94 @@ duplex string  When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it. When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.
generate-mac-address-mask string  With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered. With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. + + If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. + + If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. + + If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. + + If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.
mac-address byte array  If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing). If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).
mac-address-blacklist array of string  If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55). If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).
mtu uint32 0If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames. If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.
port string  Specific port type to use if the device supports multiple attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored. Specific port type to use if the device supports multiple attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored.
s390-nettype string  s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems. s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.
s390-options dict of string to string {}Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]). Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface. Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]). + + Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.
s390-subchannels array of string  Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character. Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.
speed uint32 0When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it. When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.
wake-on-lan uint32 1The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager). The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).
wake-on-lan-password string  If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required. If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required.
@@ -3652,7 +4022,7 @@

wireguard setting

-

WireGuard Settings.

+

WireGuard Settings.

@@ -3672,42 +4042,52 @@ fwmark - + - + - + - + - + - + - + - +
uint32 0The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets. Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark. The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets. + + Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.
ip4-auto-default-route NMTernary (int32)  Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing". Note that for this automatism to work, you usually don't want to set ipv4.gateway, because that will result in a conflicting default route. Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips. Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing". + + Note that for this automatism to work, you usually don't want to set ipv4.gateway, because that will result in a conflicting default route. + + Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.
ip6-auto-default-route NMTernary (int32)  Like ip4-auto-default-route, but for the IPv6 default route. Like ip4-auto-default-route, but for the IPv6 default route.
listen-port uint32 0The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up. The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.
mtu uint32 0If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments. If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation. If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments. + + If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation.
peer-routes boolean TRUEWhether to automatically add routes for the AllowedIPs ranges of the peers. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If FALSE, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively. Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically. Whether to automatically add routes for the AllowedIPs ranges of the peers. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If FALSE, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively. + + Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically.
@@ -3721,14 +4101,14 @@ private-key string  The 256 bit private-key in base64 encoding. The 256 bit private-key in base64 encoding.
private-key-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "private-key" property. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "private-key" property.
@@ -3736,7 +4116,7 @@

802-11-wireless setting

-

Wi-Fi Settings.

+

Wi-Fi Settings.

@@ -3756,7 +4136,13 @@ ap-isolation - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
NMTernary (int32)  Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from NM_TERNARY_DEFAULT (-1) only when the interface is configured in AP mode. If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc. If set to NM_TERNARY_FALSE (0), devices can talk to each other. When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_FALSE (0). Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from NM_TERNARY_DEFAULT (-1) only when the interface is configured in AP mode. + + If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc. + + If set to NM_TERNARY_FALSE (0), devices can talk to each other. + + When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_FALSE (0).
@@ -3770,21 +4156,23 @@ band string  802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers. 802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.
bssid byte array  If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future. If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future. + + Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.
channel uint32 0Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set. Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.
@@ -3798,63 +4186,77 @@ generate-mac-address-mask string  With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered. With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. + + If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. + + If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. + + If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. + + If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.
hidden boolean FALSEIf TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode. In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution. In AP mode, the created network does not broadcast its SSID. Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air. If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode. + + In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution. + + In AP mode, the created network does not broadcast its SSID. + + Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.
mac-address byte array  If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing). If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).
mac-address-blacklist array of string  A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55"). A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").
mac-address-randomization uint32 0One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address). This property is deprecated for 'cloned-mac-address'. Deprecated: 1 One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address). This property is deprecated for 'cloned-mac-address'. Deprecated: 1
mode string  Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed. Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.
mtu uint32 0If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames. If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.
powersave uint32 0One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved. One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.
rate uint32 0If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate. If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.
@@ -3868,28 +4270,28 @@ seen-bssids array of string  A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved. A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.
ssid byte array  SSID of the Wi-Fi network. Must be specified. SSID of the Wi-Fi network. Must be specified.
tx-power uint32 0If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power. If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.
wake-on-wlan uint32 1The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager). The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).
@@ -3897,7 +4299,7 @@

802-11-wireless-security setting

-

Wi-Fi Security Settings.

+

Wi-Fi Security Settings.

@@ -3917,140 +4319,146 @@ auth-alg - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
string  When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified. When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.
fils int32 0Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (1) (disable FILS), NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (2) (enable FILS if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (3) (enable FILS and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) and no global default is set, FILS will be optionally enabled. Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (1) (disable FILS), NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (2) (enable FILS if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (3) (enable FILS and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) and no global default is set, FILS will be optionally enabled.
group array of string  A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp". A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".
key-mgmt string  Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only). This property must be set for any Wi-Fi connection that uses security. Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only). + + This property must be set for any Wi-Fi connection that uses security.
leap-password string  The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap"). The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").
leap-password-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "leap-password" property. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "leap-password" property.
leap-username string  The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap"). The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").
pairwise array of string  A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "tkip" or "ccmp". A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "tkip" or "ccmp".
pmf int32 0Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE (1) (disable PMF), NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL (2) (enable PMF if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED (3) (enable PMF and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) and no global default is set, PMF will be optionally enabled. Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE (1) (disable PMF), NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL (2) (enable PMF if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED (3) (enable PMF and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) and no global default is set, PMF will be optionally enabled.
proto array of string  List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed. List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.
psk string  Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication. Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication.
psk-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "psk" property. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "psk" property.
wep-key-flags NMSettingSecretFlags (uint32)  Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties. (see the section called “Secret flag types:” for flag values) Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.
wep-key-type NMWepKeyType (uint32)  Controls the interpretation of WEP keys. Allowed values are NM_WEP_KEY_TYPE_KEY (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or NM_WEP_KEY_TYPE_PASSPHRASE (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key. Controls the interpretation of WEP keys. Allowed values are NM_WEP_KEY_TYPE_KEY (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or NM_WEP_KEY_TYPE_PASSPHRASE (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.
wep-key0 string  Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted. Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted.
wep-key1 string  Index 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted. Index 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.
wep-key2 string  Index 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted. Index 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.
wep-key3 string  Index 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted. Index 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.
wep-tx-keyidx uint32 0When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4. When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.
wps-method uint32 0Flags indicating which mode of WPS is to be used if any. There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities. WPS can be disabled by setting this property to a value of 1. Flags indicating which mode of WPS is to be used if any. + + There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities. + + WPS can be disabled by setting this property to a value of 1.
@@ -4058,7 +4466,7 @@

wpan setting

-

IEEE 802.15.4 (WPAN) MAC Settings.

+

IEEE 802.15.4 (WPAN) MAC Settings.

@@ -4078,35 +4486,35 @@ channel - + - + - + - + - +
int32 -1IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to". IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".
mac-address string  If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches. If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.
page int32 -1IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to". IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".
pan-id uint32 65535IEEE 802.15.4 Personal Area Network (PAN) identifier. IEEE 802.15.4 Personal Area Network (PAN) identifier.
short-address uint32 65535Short IEEE 802.15.4 address to be used within a restricted environment. Short IEEE 802.15.4 address to be used within a restricted environment.
@@ -4114,7 +4522,7 @@

bond-port setting

-

Bond Port Settings.

+

Bond Port Settings.

@@ -4133,14 +4541,14 @@ queue-id - +
uint32 0The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device. The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.

hostname setting

-

Hostname settings.

+

Hostname settings.

@@ -4160,28 +4568,40 @@ from-dhcp - + - + - + - +
NMTernary (int32)  Whether the system hostname can be determined from DHCP on this connection. When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1). Whether the system hostname can be determined from DHCP on this connection. + + When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).
from-dns-lookup NMTernary (int32)  Whether the system hostname can be determined from reverse DNS lookup of addresses on this device. When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1). Whether the system hostname can be determined from reverse DNS lookup of addresses on this device. + + When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).
only-from-default NMTernary (int32)  If set to NM_TERNARY_TRUE (1), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6). If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn't have the default route. When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_FALSE (0). If set to NM_TERNARY_TRUE (1), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6). + + If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn't have the default route. + + When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_FALSE (0).
priority int32 0The relative priority of this connection to determine the system hostname. A lower numerical value is better (higher priority). A connection with higher priority is considered before connections with lower priority. If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100. Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname. The relative priority of this connection to determine the system hostname. A lower numerical value is better (higher priority). A connection with higher priority is considered before connections with lower priority. + + If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100. + + Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname.
@@ -4189,7 +4609,7 @@

ovs-external-ids setting

-

OVS External IDs Settings.

+

OVS External IDs Settings.

@@ -4208,14 +4628,14 @@ data - +
dict of string to string {}A dictionary of key/value pairs with exernal-ids for OVS. A dictionary of key/value pairs with exernal-ids for OVS.

veth setting

-

Veth Settings.

+

Veth Settings.

@@ -4234,7 +4654,7 @@ peer - +
string  This property specifies the peer interface name of the veth. This property is mandatory. This property specifies the peer interface name of the veth. This property is mandatory.
diff --git a/docs/api/html/nm-settings-ifcfg-rh.html b/docs/api/html/nm-settings-ifcfg-rh.html index 390509ad..8189a493 100644 --- a/docs/api/html/nm-settings-ifcfg-rh.html +++ b/docs/api/html/nm-settings-ifcfg-rh.html @@ -1143,6 +1143,15 @@ Allowed values: yes,no,resolve
mptcp-flagsMPTCP_FLAGS(+) +missing variable means global defaultThe MPTCP flags that indicate whether MPTCP is enabled and which flags to use for the address endpoints. + +Example: MPTCP_FLAGS="signal,subflow"
wait-device-timeout DEVTIMEOUT(+) WAIT_ACTIVATION_DELAY(+) + Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event. + +Example: WAIT_ACTIVATION_DELAY=5000 + +Allowed values: delay in milliseconds.
@@ -1603,6 +1623,15 @@ Example: DHCP_FQDN=foo.bar.com Example: DHCP_VENDOR_CLASS_IDENTIFIER=foo + +link-local +IPV4_LINK_LOCAL(+) + +  +Configure link-local IP address in interaction with method + +Example: IPV4_LINK_LOCAL=auto +
@@ -1759,12 +1788,12 @@ Allowed values: IPV6_PRIVACY: no, yes (rfc3041 or rfc4941); IPV6 addr-gen-mode IPV6_ADDR_GEN_MODE -eui64 +"default-or-eui64" Configure IPv6 Stable Privacy addressing for SLAAC (RFC7217). Example: IPV6_ADDR_GEN_MODE=stable-privacy -Allowed values: IPV6_ADDR_GEN_MODE: eui64, stable-privacy +Allowed values: IPV6_ADDR_GEN_MODE: default, default-or-eui64, eui64, stable-privacy token @@ -2754,7 +2783,7 @@ Allowed values: "yes", "no"

Each secret property in a NetworkManager setting has an associated flags property that describes how to handle that secret. - In the fcfg-rh plugin variables for secret flags have a + In the ifcfg-rh plugin variables for secret flags have a _FLAGS suffix. The variables contain one or more of the following values (space separated). Missing (or empty) *_FLAGS variable means that the password is owned by NetworkManager. diff --git a/docs/api/html/nm-settings-nmcli.html b/docs/api/html/nm-settings-nmcli.html index e54b049c..672f9e43 100644 --- a/docs/api/html/nm-settings-nmcli.html +++ b/docs/api/html/nm-settings-nmcli.html @@ -68,7 +68,7 @@

connection setting

-

General Connection Profile Settings.

+

General Connection Profile Settings.

Properties:

@@ -81,7 +81,8 @@

auth-retries

-

The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection. Currently, this only applies to 802-1x authentication.

+

The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection.

+

Currently, this only applies to 802-1x authentication.

Format: int32

@@ -91,7 +92,11 @@

Alias: autoconnect

-

Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection. Autoconnect happens when the circumstances are suitable. That means for example that the device is currently managed and not active. Autoconnect thus never replaces or competes with an already active profile. Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles. If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined. Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.

+

Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection.

+

Autoconnect happens when the circumstances are suitable. That means for example that the device is currently managed and not active. Autoconnect thus never replaces or competes with an already active profile.

+

Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles.

+

If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined.

+

Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.

Format: boolean

@@ -99,7 +104,7 @@

autoconnect-priority

-

The autoconnect priority in range -999 to 999. If the connection is set to autoconnect, connections with higher priority will be preferred. The higher number means higher priority. Defaults to 0. Note that this property only matters if there are more than one candidate profile to select for autoconnect. In case of equal priority, the profile used most recently is chosen.

+

The autoconnect priority in range -999 to 999. If the connection is set to autoconnect, connections with higher priority will be preferred. The higher number means higher priority. Defaults to 0. Note that this property only matters if there are more than one candidate profile to select for autoconnect. In case of equal priority, the profile used most recently is chosen.

Format: int32

@@ -107,7 +112,7 @@

autoconnect-retries

-

The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again.

+

The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again.

Format: int32

@@ -115,7 +120,7 @@

autoconnect-slaves

-

Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0.

+

Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0.

Format: NMSettingConnectionAutoconnectSlaves (int32)

@@ -123,7 +128,9 @@

dns-over-tls

-

Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic. The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don't ever use DNSOverTls. If unspecified "default" depends on the plugin used. Systemd-resolved uses global setting. This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.

+

Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic.

+

The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don't ever use DNSOverTls. If unspecified "default" depends on the plugin used. Systemd-resolved uses global setting.

+

This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.

Format: int32

@@ -131,7 +138,7 @@

gateway-ping-timeout

-

If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.

+

If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.

Format: uint32

@@ -141,7 +148,7 @@

Alias: con-name

-

A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".

+

A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".

Format: string

@@ -151,7 +158,9 @@

Alias: ifname

-

The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings). For software devices this specifies the name of the created device. For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.

+

The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings).

+

For software devices this specifies the name of the created device.

+

For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.

Format: string

@@ -159,7 +168,7 @@

lldp

-

Whether LLDP is enabled for the connection.

+

Whether LLDP is enabled for the connection.

Format: int32

@@ -167,7 +176,9 @@

llmnr

-

Whether Link-Local Multicast Name Resolution (LLMNR) is enabled for the connection. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link. The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes"). This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.

+

Whether Link-Local Multicast Name Resolution (LLMNR) is enabled for the connection. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link.

+

The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes").

+

This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.

Format: int32

@@ -177,7 +188,7 @@

Alias: master

-

Interface name of the master device or UUID of the master connection.

+

Interface name of the master device or UUID of the master connection.

Format: string

@@ -185,7 +196,9 @@

mdns

-

Whether mDNS is enabled for the connection. The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (-1) to allow lookup of a global default in NetworkManager.conf. If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "no"). This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.

+

Whether mDNS is enabled for the connection.

+

The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (-1) to allow lookup of a global default in NetworkManager.conf. If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "no").

+

This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.

Format: int32

@@ -193,15 +206,33 @@

metered

-

Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately.

+

Whether the connection is metered.

+

When updating this property on a currently activated connection, the change takes effect immediately.

Format: NMMetered (int32)

+

mptcp-flags

+ +

Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints.

+

If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered.

+

The flag "enabled-on-global-iface" (0x2) means that MPTCP handling is enabled if the interface configures a default route in the main routing table. This choice is per-address family, for example if there is an IPv4 default route 0.0.0.0/0, IPv4 endpoints are configured.

+

The "enabled" (0x4) flag means that MPTCP handling is explicitly enabled. This flag can also be implied from the presence of other flags.

+

If MPTCP handling is enabled, then endpoints will be configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags.

+

If the flags are zero, the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is either "disabled" or "enabled-on-global-iface,subflow" depending on "/proc/sys/net/mptcp/enabled".

+

NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp.

+

Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).

+

+ Format: uint32

+ + +

mud-url

-

If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer-recommended network policies for IoT devices. It is transmitted as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://". The special value "none" is allowed to indicate that no MUD URL is used. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".

+

If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer-recommended network policies for IoT devices. It is transmitted as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://".

+

The special value "none" is allowed to indicate that no MUD URL is used.

+

If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".

Format: string

@@ -209,7 +240,7 @@

multi-connect

-

Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.

+

Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.

Format: int32

@@ -217,7 +248,8 @@

permissions

-

An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection; otherwise users are allowed if and only if they are in this list. When this is not empty, the connection can be active only when one of the specified users is logged into an active session. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.

+

An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection; otherwise users are allowed if and only if they are in this list. When this is not empty, the connection can be active only when one of the specified users is logged into an active session. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah".

+

At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.

Format: array of string

@@ -225,7 +257,7 @@

read-only

-

FALSE if the connection can be modified using the provided settings service's D-Bus interface with the right privileges, or TRUE if the connection is read-only and cannot be modified.

+

FALSE if the connection can be modified using the provided settings service's D-Bus interface with the right privileges, or TRUE if the connection is read-only and cannot be modified.

Format: boolean

@@ -233,7 +265,7 @@

secondaries

-

List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.

+

List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.

Format: array of string

@@ -243,7 +275,7 @@

Alias: slave-type

-

Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.

+

Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.

Format: string

@@ -251,7 +283,11 @@

stable-id

-

This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context. The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used as DHCP client identifier with ipv4.dhcp-client-id=stable and to derive the DHCP DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid]. Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key. See NetworkManager(8) manual about the secret-key and the host identity. The '$' character is treated special to perform dynamic substitutions at runtime. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-boot, or every time. Note that "${DEVICE}" corresponds to the interface name of the device and "${MAC}" is the permanent MAC address of the device. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates. If the value is unset, a global connection default is consulted. If the value is still unset, the default is similar to "${CONNECTION}" and uses a unique, fixed ID for the connection.

+

This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context.

+

The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used as DHCP client identifier with ipv4.dhcp-client-id=stable and to derive the DHCP DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid].

+

Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key. See NetworkManager(8) manual about the secret-key and the host identity.

+

The '$' character is treated special to perform dynamic substitutions at runtime. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-boot, or every time. Note that "${DEVICE}" corresponds to the interface name of the device and "${MAC}" is the permanent MAC address of the device. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates.

+

If the value is unset, a global connection default is consulted. If the value is still unset, the default is similar to "${CONNECTION}" and uses a unique, fixed ID for the connection.

Format: string

@@ -259,7 +295,8 @@

timestamp

-

The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated. NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).

+

The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated.

+

NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).

Format: uint64

@@ -269,7 +306,7 @@

Alias: type

-

Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).

+

Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).

Format: string

@@ -277,15 +314,26 @@

uuid

-

A universally unique identifier for the connection, for example generated with libuuid. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes. The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").

+

A universally unique identifier for the connection, for example generated with libuuid. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes.

+

The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").

Format: string

+

wait-activation-delay

+ +

Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event.

+

The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.

+

+ Format: int32

+ + +

wait-device-timeout

-

Timeout in milliseconds to wait for device at startup. During boot, devices may take a while to be detected by the driver. This property will cause to delay NetworkManager-wait-online.service and nm-online to give the device a chance to appear. This works by waiting for the given timeout until a compatible device for the profile is available and managed. The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.

+

Timeout in milliseconds to wait for device at startup. During boot, devices may take a while to be detected by the driver. This property will cause to delay NetworkManager-wait-online.service and nm-online to give the device a chance to appear. This works by waiting for the given timeout until a compatible device for the profile is available and managed.

+

The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.

Format: int32

@@ -293,7 +341,8 @@

zone

-

The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall. When updating this property on a currently activated connection, the change takes effect immediately.

+

The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall.

+

When updating this property on a currently activated connection, the change takes effect immediately.

Format: string

@@ -304,7 +353,7 @@

6lowpan setting

-

6LoWPAN Settings.

+

6LoWPAN Settings.

Properties:

@@ -318,7 +367,7 @@

Alias: dev

-

If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.

+

If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.

Format: string

@@ -328,7 +377,7 @@

802-1x setting

-

IEEE 802.1x Authentication Settings.

+

IEEE 802.1x Authentication Settings.

Properties:

@@ -341,7 +390,7 @@

altsubject-matches

-

List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.

+

List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.

Format: array of string

@@ -349,7 +398,7 @@

anonymous-identity

-

Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.

+

Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.

Format: string

@@ -357,7 +406,7 @@

auth-timeout

-

A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.

+

A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.

Format: int32

@@ -365,7 +414,9 @@

ca-cert

-

Contains the CA certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.

+

Contains the CA certificate if used by the EAP method specified in the "eap" property.

+

Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.

+

Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.

Format: byte array

@@ -373,7 +424,7 @@

ca-cert-password

-

The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.

+

The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.

Format: string

@@ -381,9 +432,7 @@

ca-cert-password-flags

-

Flags indicating how to handle the "ca-cert-password" property. - See the section called “Secret flag types:” for flag values. -

+

Flags indicating how to handle the "ca-cert-password" property.

Format: NMSettingSecretFlags (uint32)

@@ -391,7 +440,8 @@

ca-path

-

UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property. If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.

+

UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property.

+

If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.

Format: string

@@ -399,7 +449,8 @@

client-cert

-

Contains the client certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte.

+

Contains the client certificate if used by the EAP method specified in the "eap" property.

+

Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte.

Format: byte array

@@ -407,7 +458,7 @@

client-cert-password

-

The password used to access the client certificate stored in "client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.

+

The password used to access the client certificate stored in "client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.

Format: string

@@ -415,9 +466,7 @@

client-cert-password-flags

-

Flags indicating how to handle the "client-cert-password" property. - See the section called “Secret flag types:” for flag values. -

+

Flags indicating how to handle the "client-cert-password" property.

Format: NMSettingSecretFlags (uint32)

@@ -425,7 +474,7 @@

domain-match

-

Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.

+

Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.

Format: string

@@ -433,7 +482,7 @@

domain-suffix-match

-

Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.

+

Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.

Format: string

@@ -441,7 +490,7 @@

eap

-

The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast". Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.

+

The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast". Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.

Format: array of string

@@ -449,7 +498,7 @@

identity

-

Identity string for EAP authentication methods. Often the user's user or login name.

+

Identity string for EAP authentication methods. Often the user's user or login name.

Format: string

@@ -457,7 +506,7 @@

optional

-

Whether the 802.1X authentication is optional. If TRUE, the activation will continue even after a timeout or an authentication failure. Setting the property to TRUE is currently allowed only for Ethernet connections. If set to FALSE, the activation can continue only after a successful authentication.

+

Whether the 802.1X authentication is optional. If TRUE, the activation will continue even after a timeout or an authentication failure. Setting the property to TRUE is currently allowed only for Ethernet connections. If set to FALSE, the activation can continue only after a successful authentication.

Format: boolean

@@ -465,7 +514,7 @@

pac-file

-

UTF-8 encoded file path containing PAC for EAP-FAST.

+

UTF-8 encoded file path containing PAC for EAP-FAST.

Format: string

@@ -473,7 +522,7 @@

password

-

UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.

+

UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.

Format: string

@@ -481,9 +530,7 @@

password-flags

-

Flags indicating how to handle the "password" property. - See the section called “Secret flag types:” for flag values. -

+

Flags indicating how to handle the "password" property.

Format: NMSettingSecretFlags (uint32)

@@ -491,7 +538,7 @@

password-raw

-

Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.

+

Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.

Format: byte array

@@ -499,9 +546,7 @@

password-raw-flags

-

Flags indicating how to handle the "password-raw" property. - See the section called “Secret flag types:” for flag values. -

+

Flags indicating how to handle the "password-raw" property.

Format: NMSettingSecretFlags (uint32)

@@ -509,7 +554,7 @@

phase1-auth-flags

-

Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x settings. See the wpa_supplicant documentation for more details.

+

Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x settings. See the wpa_supplicant documentation for more details.

Format: uint32

@@ -517,7 +562,7 @@

phase1-fast-provisioning

-

Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.

+

Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.

Format: string

@@ -525,7 +570,7 @@

phase1-peaplabel

-

Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.

+

Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.

Format: string

@@ -533,7 +578,7 @@

phase1-peapver

-

Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.

+

Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.

Format: string

@@ -541,7 +586,7 @@

phase2-altsubject-matches

-

List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.

+

List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.

Format: array of string

@@ -549,7 +594,7 @@

phase2-auth

-

Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.

+

Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.

Format: string

@@ -557,7 +602,7 @@

phase2-autheap

-

Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.

+

Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.

Format: string

@@ -565,7 +610,9 @@

phase2-ca-cert

-

Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.

+

Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.

+

Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.

+

Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.

Format: byte array

@@ -573,7 +620,7 @@

phase2-ca-cert-password

-

The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.

+

The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.

Format: string

@@ -581,9 +628,7 @@

phase2-ca-cert-password-flags

-

Flags indicating how to handle the "phase2-ca-cert-password" property. - See the section called “Secret flag types:” for flag values. -

+

Flags indicating how to handle the "phase2-ca-cert-password" property.

Format: NMSettingSecretFlags (uint32)

@@ -591,7 +636,8 @@

phase2-ca-path

-

UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property. If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.

+

UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property.

+

If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.

Format: string

@@ -599,7 +645,8 @@

phase2-client-cert

-

Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.

+

Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.

+

Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.

Format: byte array

@@ -607,7 +654,7 @@

phase2-client-cert-password

-

The password used to access the "phase2" client certificate stored in "phase2-client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.

+

The password used to access the "phase2" client certificate stored in "phase2-client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.

Format: string

@@ -615,9 +662,7 @@

phase2-client-cert-password-flags

-

Flags indicating how to handle the "phase2-client-cert-password" property. - See the section called “Secret flag types:” for flag values. -

+

Flags indicating how to handle the "phase2-client-cert-password" property.

Format: NMSettingSecretFlags (uint32)

@@ -625,7 +670,7 @@

phase2-domain-match

-

Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.

+

Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.

Format: string

@@ -633,7 +678,7 @@

phase2-domain-suffix-match

-

Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.

+

Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.

Format: string

@@ -641,7 +686,8 @@

phase2-private-key

-

Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.

+

Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls".

+

Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.

Format: byte array

@@ -649,7 +695,7 @@

phase2-private-key-password

-

The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS#12 format key.

+

The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS#12 format key.

Format: string

@@ -657,9 +703,7 @@

phase2-private-key-password-flags

-

Flags indicating how to handle the "phase2-private-key-password" property. - See the section called “Secret flag types:” for flag values. -

+

Flags indicating how to handle the "phase2-private-key-password" property.

Format: NMSettingSecretFlags (uint32)

@@ -667,7 +711,7 @@

phase2-subject-match

-

Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2-domain-suffix-match.

+

Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2-domain-suffix-match.

Format: string

@@ -675,7 +719,7 @@

pin

-

PIN used for EAP authentication methods.

+

PIN used for EAP authentication methods.

Format: string

@@ -683,9 +727,7 @@

pin-flags

-

Flags indicating how to handle the "pin" property. - See the section called “Secret flag types:” for flag values. -

+

Flags indicating how to handle the "pin" property.

Format: NMSettingSecretFlags (uint32)

@@ -693,7 +735,9 @@

private-key

-

Contains the private key when the "eap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.

+

Contains the private key when the "eap" property is set to "tls".

+

Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.

+

WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.

Format: byte array

@@ -701,7 +745,7 @@

private-key-password

-

The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.

+

The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.

Format: string

@@ -709,9 +753,7 @@

private-key-password-flags

-

Flags indicating how to handle the "private-key-password" property. - See the section called “Secret flag types:” for flag values. -

+

Flags indicating how to handle the "private-key-password" property.

Format: NMSettingSecretFlags (uint32)

@@ -719,7 +761,7 @@

subject-match

-

Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain-suffix-match.

+

Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain-suffix-match.

Format: string

@@ -727,7 +769,7 @@

system-ca-certs

-

When TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).

+

When TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).

Format: boolean

@@ -738,7 +780,7 @@

adsl setting

-

ADSL Settings.

+

ADSL Settings.

Properties:

@@ -753,7 +795,7 @@

Alias: encapsulation

-

Encapsulation of ADSL connection. Can be "vcmux" or "llc".

+

Encapsulation of ADSL connection. Can be "vcmux" or "llc".

Format: string

@@ -763,7 +805,7 @@

Alias: password

-

Password used to authenticate with the ADSL service.

+

Password used to authenticate with the ADSL service.

Format: string

@@ -771,9 +813,7 @@

password-flags

-

Flags indicating how to handle the "password" property. - See the section called “Secret flag types:” for flag values. -

+

Flags indicating how to handle the "password" property.

Format: NMSettingSecretFlags (uint32)

@@ -783,7 +823,7 @@

Alias: protocol

-

ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".

+

ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".

Format: string

@@ -793,7 +833,7 @@

Alias: username

-

Username used to authenticate with the ADSL service.

+

Username used to authenticate with the ADSL service.

Format: string

@@ -801,7 +841,7 @@

vci

-

VCI of ADSL connection

+

VCI of ADSL connection

Format: uint32

@@ -809,7 +849,7 @@

vpi

-

VPI of ADSL connection

+

VPI of ADSL connection

Format: uint32

@@ -820,7 +860,7 @@

bluetooth setting

-

Bluetooth Settings.

+

Bluetooth Settings.

Properties:

@@ -835,7 +875,7 @@

Alias: addr

-

The Bluetooth address of the device.

+

The Bluetooth address of the device.

Format: byte array

@@ -845,7 +885,7 @@

Alias: bt-type

-

Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.

+

Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.

Format: string

@@ -856,7 +896,7 @@

bond setting

-

Bonding Settings.

+

Bonding Settings.

Properties:

@@ -868,7 +908,7 @@

options

-

Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).

+

Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).

Format: dict of string to string

@@ -878,7 +918,7 @@

bridge setting

-

Bridging Settings.

+

Bridging Settings.

Properties:

@@ -893,7 +933,7 @@

Alias: ageing-time

-

The Ethernet MAC address aging time, in seconds.

+

The Ethernet MAC address aging time, in seconds.

Format: uint32

@@ -903,7 +943,7 @@

Alias: forward-delay

-

The Spanning Tree Protocol (STP) forwarding delay, in seconds.

+

The Spanning Tree Protocol (STP) forwarding delay, in seconds.

Format: uint32

@@ -911,7 +951,8 @@

group-address

-

If specified, The MAC address of the multicast group this bridge uses for STP. The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00.

+

If specified, The MAC address of the multicast group this bridge uses for STP.

+

The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00.

Format: byte array

@@ -921,7 +962,7 @@

Alias: group-forward-mask

-

A mask of group addresses to forward. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can't have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP.

+

A mask of group addresses to forward. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can't have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP.

Format: uint32

@@ -931,7 +972,7 @@

Alias: hello-time

-

The Spanning Tree Protocol (STP) hello time, in seconds.

+

The Spanning Tree Protocol (STP) hello time, in seconds.

Format: uint32

@@ -941,7 +982,8 @@

Alias: mac

-

If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge. Hence, this property is deprecated. Deprecated: 1

+

If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set.

+

If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge. Hence, this property is deprecated. Deprecated: 1

Format: byte array

@@ -951,7 +993,7 @@

Alias: max-age

-

The Spanning Tree Protocol (STP) maximum message age, in seconds.

+

The Spanning Tree Protocol (STP) maximum message age, in seconds.

Format: uint32

@@ -959,7 +1001,7 @@

multicast-hash-max

-

Set maximum size of multicast hash table (value must be a power of 2).

+

Set maximum size of multicast hash table (value must be a power of 2).

Format: uint32

@@ -967,7 +1009,7 @@

multicast-last-member-count

-

Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.

+

Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.

Format: uint32

@@ -975,7 +1017,7 @@

multicast-last-member-interval

-

Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.

+

Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.

Format: uint64

@@ -983,7 +1025,7 @@

multicast-membership-interval

-

Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.

+

Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.

Format: uint64

@@ -991,7 +1033,7 @@

multicast-querier

-

Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.

+

Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.

Format: boolean

@@ -999,7 +1041,7 @@

multicast-querier-interval

-

If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.

+

If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.

Format: uint64

@@ -1007,7 +1049,7 @@

multicast-query-interval

-

Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.

+

Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.

Format: uint64

@@ -1015,7 +1057,7 @@

multicast-query-response-interval

-

Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.

+

Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.

Format: uint64

@@ -1023,7 +1065,7 @@

multicast-query-use-ifaddr

-

If enabled the bridge's own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used.

+

If enabled the bridge's own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used.

Format: boolean

@@ -1031,7 +1073,8 @@

multicast-router

-

Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work. Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).

+

Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work.

+

Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).

Format: string

@@ -1041,7 +1084,7 @@

Alias: multicast-snooping

-

Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.

+

Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.

Format: boolean

@@ -1049,7 +1092,7 @@

multicast-startup-query-count

-

Set the number of IGMP queries to send during startup phase.

+

Set the number of IGMP queries to send during startup phase.

Format: uint32

@@ -1057,7 +1100,7 @@

multicast-startup-query-interval

-

Sets the time (in deciseconds) between queries sent out at startup to determine membership information.

+

Sets the time (in deciseconds) between queries sent out at startup to determine membership information.

Format: uint64

@@ -1067,7 +1110,7 @@

Alias: priority

-

Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.

+

Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.

Format: uint32

@@ -1077,7 +1120,7 @@

Alias: stp

-

Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.

+

Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.

Format: boolean

@@ -1085,7 +1128,7 @@

vlan-default-pvid

-

The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.

+

The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.

Format: uint32

@@ -1093,7 +1136,7 @@

vlan-filtering

-

Control whether VLAN filtering is enabled on the bridge.

+

Control whether VLAN filtering is enabled on the bridge.

Format: boolean

@@ -1101,7 +1144,8 @@

vlan-protocol

-

If specified, the protocol used for VLAN filtering. Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.

+

If specified, the protocol used for VLAN filtering.

+

Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.

Format: string

@@ -1109,7 +1153,7 @@

vlan-stats-enabled

-

Controls whether per-VLAN stats accounting is enabled.

+

Controls whether per-VLAN stats accounting is enabled.

Format: boolean

@@ -1117,7 +1161,10 @@

vlans

-

Array of bridge VLAN objects. In addition to the VLANs specified here, the bridge will also have the default-pvid VLAN configured by the bridge.vlan-default-pvid property. In nmcli the VLAN list can be specified with the following syntax: $vid [pvid] [untagged] [, $vid [pvid] [untagged]]... where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.

+

Array of bridge VLAN objects. In addition to the VLANs specified here, the bridge will also have the default-pvid VLAN configured by the bridge.vlan-default-pvid property.

+

In nmcli the VLAN list can be specified with the following syntax:

+

$vid [pvid] [untagged] [, $vid [pvid] [untagged]]...

+

where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.

Format: array of vardict

@@ -1128,7 +1175,7 @@

bridge-port setting

-

Bridge Port Settings.

+

Bridge Port Settings.

Properties:

@@ -1143,7 +1190,7 @@

Alias: hairpin

-

Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.

+

Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.

Format: boolean

@@ -1153,7 +1200,7 @@

Alias: path-cost

-

The Spanning Tree Protocol (STP) port cost for destinations via this port.

+

The Spanning Tree Protocol (STP) port cost for destinations via this port.

Format: uint32

@@ -1163,7 +1210,7 @@

Alias: priority

-

The Spanning Tree Protocol (STP) priority of this bridge port.

+

The Spanning Tree Protocol (STP) priority of this bridge port.

Format: uint32

@@ -1171,7 +1218,10 @@

vlans

-

Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property. In nmcli the VLAN list can be specified with the following syntax: $vid [pvid] [untagged] [, $vid [pvid] [untagged]]... where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.

+

Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property.

+

In nmcli the VLAN list can be specified with the following syntax:

+

$vid [pvid] [untagged] [, $vid [pvid] [untagged]]...

+

where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.

Format: array of vardict

@@ -1182,7 +1232,7 @@

cdma setting

-

CDMA-based Mobile Broadband Settings.

+

CDMA-based Mobile Broadband Settings.

Properties:

@@ -1195,7 +1245,7 @@

mtu

-

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.

+

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.

Format: uint32

@@ -1203,7 +1253,7 @@

number

-

The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required.

+

The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required.

Format: string

@@ -1213,7 +1263,7 @@

Alias: password

-

The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.

+

The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.

Format: string

@@ -1221,9 +1271,7 @@

password-flags

-

Flags indicating how to handle the "password" property. - See the section called “Secret flag types:” for flag values. -

+

Flags indicating how to handle the "password" property.

Format: NMSettingSecretFlags (uint32)

@@ -1233,7 +1281,7 @@

Alias: user

-

The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.

+

The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.

Format: string

@@ -1244,7 +1292,7 @@

dcb setting

-

Data Center Bridging Settings.

+

Data Center Bridging Settings.

Properties:

@@ -1257,7 +1305,7 @@

app-fcoe-flags

-

Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).

+

Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).

Format: NMSettingDcbFlags (uint32)

@@ -1265,7 +1313,8 @@

app-fcoe-mode

-

The FCoE controller mode; either "fabric" or "vn2vn". Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".

+

The FCoE controller mode; either "fabric" or "vn2vn".

+

Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".

Format: string

@@ -1273,7 +1322,7 @@

app-fcoe-priority

-

The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.

+

The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.

Format: int32

@@ -1281,7 +1330,7 @@

app-fip-flags

-

Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).

+

Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).

Format: NMSettingDcbFlags (uint32)

@@ -1289,7 +1338,7 @@

app-fip-priority

-

The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.

+

The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.

Format: int32

@@ -1297,7 +1346,7 @@

app-iscsi-flags

-

Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).

+

Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).

Format: NMSettingDcbFlags (uint32)

@@ -1305,7 +1354,7 @@

app-iscsi-priority

-

The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.

+

The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.

Format: int32

@@ -1313,7 +1362,7 @@

priority-bandwidth

-

An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents.

+

An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents.

Format: array of uint32

@@ -1321,7 +1370,7 @@

priority-flow-control

-

An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.

+

An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.

Format: array of uint32

@@ -1329,7 +1378,7 @@

priority-flow-control-flags

-

Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).

+

Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).

Format: NMSettingDcbFlags (uint32)

@@ -1337,7 +1386,7 @@

priority-group-bandwidth

-

An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percents.

+

An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percents.

Format: array of uint32

@@ -1345,7 +1394,7 @@

priority-group-flags

-

Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).

+

Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).

Format: NMSettingDcbFlags (uint32)

@@ -1353,7 +1402,7 @@

priority-group-id

-

An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.

+

An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.

Format: array of uint32

@@ -1361,7 +1410,7 @@

priority-strict-bandwidth

-

An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.

+

An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.

Format: array of uint32

@@ -1369,7 +1418,7 @@

priority-traffic-class

-

An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.

+

An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.

Format: array of uint32

@@ -1380,7 +1429,7 @@

ethtool setting

-

Ethtool Ethernet Settings.

+

Ethtool Ethernet Settings.

Properties:

@@ -1712,15 +1761,15 @@

pause-autoneg

-

Whether to automatically negotiate on pause frame of flow control mechanism defined by IEEE 802.3x standard.

+

pause-rx

-

Whether RX pause should be enabled. Only valid when automatic negotiation is disabled

+

pause-tx

-

Whether TX pause should be enabled. Only valid when automatic negotiation is disabled

+

ring-rx

@@ -1744,7 +1793,7 @@

gsm setting

-

GSM-based Mobile Broadband Settings.

+

GSM-based Mobile Broadband Settings.

Properties:

@@ -1759,7 +1808,7 @@

Alias: apn

-

The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.

+

The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.

Format: string

@@ -1767,7 +1816,7 @@

auto-config

-

When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.

+

When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.

Format: boolean

@@ -1775,7 +1824,7 @@

device-id

-

The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.

+

The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.

Format: string

@@ -1783,7 +1832,7 @@

home-only

-

When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.

+

When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.

Format: boolean

@@ -1791,7 +1840,7 @@

mtu

-

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.

+

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.

Format: uint32

@@ -1799,7 +1848,7 @@

network-id

-

The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.

+

The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.

Format: string

@@ -1807,7 +1856,7 @@

number

-

Legacy setting that used to help establishing PPP data sessions for GSM-based modems. Deprecated: 1

+

Legacy setting that used to help establishing PPP data sessions for GSM-based modems. Deprecated: 1

Format: string

@@ -1817,7 +1866,7 @@

Alias: password

-

The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.

+

The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.

Format: string

@@ -1825,9 +1874,7 @@

password-flags

-

Flags indicating how to handle the "password" property. - See the section called “Secret flag types:” for flag values. -

+

Flags indicating how to handle the "password" property.

Format: NMSettingSecretFlags (uint32)

@@ -1835,7 +1882,7 @@

pin

-

If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.

+

If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.

Format: string

@@ -1843,9 +1890,7 @@

pin-flags

-

Flags indicating how to handle the "pin" property. - See the section called “Secret flag types:” for flag values. -

+

Flags indicating how to handle the "pin" property.

Format: NMSettingSecretFlags (uint32)

@@ -1853,7 +1898,7 @@

sim-id

-

The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.

+

The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.

Format: string

@@ -1861,7 +1906,7 @@

sim-operator-id

-

A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.

+

A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.

Format: string

@@ -1871,7 +1916,7 @@

Alias: user

-

The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.

+

The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.

Format: string

@@ -1882,7 +1927,7 @@

infiniband setting

-

Infiniband Settings.

+

Infiniband Settings.

Properties:

@@ -1897,7 +1942,7 @@

Alias: mac

-

If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).

+

If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).

Format: byte array

@@ -1907,7 +1952,7 @@

Alias: mtu

-

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.

+

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.

Format: uint32

@@ -1917,7 +1962,7 @@

Alias: p-key

-

The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key.

+

The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key.

Format: int32

@@ -1927,7 +1972,7 @@

Alias: parent

-

The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".

+

The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".

Format: string

@@ -1937,7 +1982,7 @@

Alias: transport-mode

-

The IP-over-InfiniBand transport mode. Either "datagram" or "connected".

+

The IP-over-InfiniBand transport mode. Either "datagram" or "connected".

Format: string

@@ -1948,7 +1993,7 @@

ipv4 setting

-

IPv4 Settings.

+

IPv4 Settings.

Properties:

@@ -1963,7 +2008,7 @@

Alias: ip4

-

A list of IPv4 addresses and their prefix length. Multiple addresses can be separated by comma. For example "192.168.1.5/24, 10.1.0.5/24". The addresses are listed in decreasing priority, meaning the first address will be the primary address.

+

Array of IP addresses.

Format: a comma separated list of addresses

@@ -1971,7 +2016,8 @@

dad-timeout

-

Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds. The property is currently implemented only for IPv4.

+

Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds.

+

The property is currently implemented only for IPv4.

Format: int32

@@ -1979,7 +2025,12 @@

dhcp-client-id

-

A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0. The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links. The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset. The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id. The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key. If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin.

+

A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0.

+

The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links.

+

The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset.

+

The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id.

+

The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key.

+

If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin.

Format: string

@@ -1987,7 +2038,7 @@

dhcp-fqdn

-

If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.

+

If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.

Format: string

@@ -1995,7 +2046,7 @@

dhcp-hostname

-

If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.

+

If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.

Format: string

@@ -2003,7 +2054,9 @@

dhcp-hostname-flags

-

Flags for the DHCP hostname and FQDN. Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.

+

Flags for the DHCP hostname and FQDN.

+

Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6.

+

When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.

Format: uint32

@@ -2011,7 +2064,7 @@

dhcp-iaid

-

A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.

+

A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.

Format: string

@@ -2019,7 +2072,9 @@

dhcp-reject-servers

-

Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). This property is currently not implemented for DHCPv6.

+

Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers.

+

For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24").

+

This property is currently not implemented for DHCPv6.

Format: array of string

@@ -2027,7 +2082,7 @@

dhcp-send-hostname

-

If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.

+

If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.

Format: boolean

@@ -2035,7 +2090,8 @@

dhcp-timeout

-

A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). Set to 2147483647 (MAXINT32) for infinity.

+

A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds).

+

Set to 2147483647 (MAXINT32) for infinity.

Format: int32

@@ -2043,7 +2099,8 @@

dhcp-vendor-class-identifier

-

The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server. Since 1.28

+

The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.

+

Since 1.28

Format: string

@@ -2051,7 +2108,7 @@

dns

-

Array of IP addresses of DNS servers.

+

Array of IP addresses of DNS servers.

Format: array of uint32

@@ -2059,7 +2116,11 @@

dns-options

-

Array of DNS options as described in man 5 resolv.conf. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties. The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.

+

Array of DNS options as described in man 5 resolv.conf.

+

NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties.

+

The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc".

+

The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.

+

When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.

Format: array of string

@@ -2067,7 +2128,14 @@

dns-priority

-

DNS servers priority. The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections. Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.

+

DNS servers priority.

+

The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).

+

Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.

+

Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections.

+

Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile.

+

When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices.

+

When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.

+

When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.

Format: int32

@@ -2075,7 +2143,9 @@

dns-search

-

Array of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names. When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.

+

List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.

+

When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.

+

When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).

Format: array of string

@@ -2085,7 +2155,9 @@

Alias: gw4

-

The gateway associated with this configuration. This is only meaningful if "addresses" is also set. The gateway's main purpose is to control the next hop of the standard default route on the device. Hence, the gateway property conflicts with "never-default" and will be automatically dropped if the IP configuration is set to never-default. As an alternative to set the gateway, configure a static default route with /0 as prefix length.

+

The gateway associated with this configuration. This is only meaningful if "addresses" is also set.

+

The gateway's main purpose is to control the next hop of the standard default route on the device. Hence, the gateway property conflicts with "never-default" and will be automatically dropped if the IP configuration is set to never-default.

+

As an alternative to set the gateway, configure a static default route with /0 as prefix length.

Format: string

@@ -2093,7 +2165,7 @@

ignore-auto-dns

-

When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.

+

When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.

Format: boolean

@@ -2101,15 +2173,25 @@

ignore-auto-routes

-

When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.

+

When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.

Format: boolean

+

link-local

+ +

Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server.

+

When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".

+

Since 1.40

+

+ Format: int32

+ + +

may-fail

-

If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.

+

If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.

Format: boolean

@@ -2117,7 +2199,11 @@

method

-

IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.

+

IP configuration method.

+

NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values.

+

In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior.

+

For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty.

+

For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.

Format: string

@@ -2125,7 +2211,7 @@

never-default

-

If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.

+

If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.

Format: boolean

@@ -2133,7 +2219,10 @@

required-timeout

-

The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).

+

The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.

+

This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.

+

Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.

+

A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).

Format: int32

@@ -2141,7 +2230,7 @@

route-metric

-

The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.

+

The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.

Format: int64

@@ -2149,7 +2238,10 @@

route-table

-

Enable policy routing (source routing) and set the routing table used when adding routes. This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.

+

Enable policy routing (source routing) and set the routing table used when adding routes.

+

This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.

+

If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.

+

Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.

Format: uint32

@@ -2167,9 +2259,11 @@ For example "192.0.2.0/24 10.1.1.1 77, 198.51.100.0/24". Various attributes are supported:

    +

  • "advmss" - an unsigned 32 bit integer.

  • "cwnd" - an unsigned 32 bit integer.

  • "initcwnd" - an unsigned 32 bit integer.

  • "initrwnd" - an unsigned 32 bit integer.

    • +

  • "lock-advmss" - a boolean value.

  • "lock-cwnd" - a boolean value.

  • "lock-initcwnd" - a boolean value.

  • "lock-initrwnd" - a boolean value.

    • @@ -2177,6 +2271,9 @@ Various attributes are supported:

  • "lock-window" - a boolean value.

  • "mtu" - an unsigned 32 bit integer.

  • "onlink" - a boolean value.

    • +

  • "quickack" - a boolean value.

    • +

  • "rto_min" - an unsigned 32 bit integer. +The value is in milliseconds.

  • "scope" - an unsigned 8 bit integer. IPv4 only.

  • "src" - an IPv4 address.

  • "table" - an unsigned 32 bit integer. The default depends on ipv4.route-table.

    • @@ -2217,7 +2314,7 @@ Example: priority 5 from 192.167.4.0/24 table 45

    ipv6 setting

    -

    IPv6 Settings.

    +

    IPv6 Settings.

    Properties:

    @@ -2230,7 +2327,12 @@ Example: priority 5 from 192.167.4.0/24 table 45

    addr-gen-mode

    -

    Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced. The value of stable-privacy enables use of cryptographically secure hash of a secret host-specific key along with the connection's stable-id and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced. On D-Bus, the absence of an addr-gen-mode setting equals enabling stable-privacy. For keyfile plugin, the absence of the setting on disk means EUI64 so that the property doesn't change on upgrade from older versions. Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.

    +

    Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3).

    +

    If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced.

    +

    The value of stable-privacy enables use of cryptographically secure hash of a secret host-specific key along with the connection's stable-id and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced.

    +

    The special values "default" and "default-or-eui64" will fallback to the global connection default in as documented in NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively.

    +

    For libnm, the property defaults to "default" since 1.40. Previously it defaulted to "stable-privacy". On D-Bus, the absence of an addr-gen-mode setting equals "default". For keyfile plugin, the absence of the setting on disk means "default-or-eui64" so that the property doesn't change on upgrade from older versions.

    +

    Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.

    Format: int32

    @@ -2240,7 +2342,7 @@ Example: priority 5 from 192.167.4.0/24 table 45

    Alias: ip6

    -

    A list of IPv6 addresses and their prefix length. Multiple addresses can be separated by comma. For example "2001:db8:85a3::8a2e:370:7334/64, 2001:db8:85a3::5/64". The addresses are listed in decreasing priority, meaning the first address will be the primary address. This can make a difference with IPv6 source address selection (RFC 6724, section 5).

    +

    Array of IP addresses.

    Format: a comma separated list of addresses

    @@ -2248,7 +2350,11 @@ Example: priority 5 from 192.167.4.0/24 table 45

    dhcp-duid

    -

    A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option. The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id. The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk. The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt"). When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.

    +

    A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option.

    +

    The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id.

    +

    The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk.

    +

    The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt").

    +

    When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.

    Format: string

    @@ -2256,7 +2362,7 @@ Example: priority 5 from 192.167.4.0/24 table 45

    dhcp-hostname

    -

    If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.

    +

    If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.

    Format: string

    @@ -2264,7 +2370,9 @@ Example: priority 5 from 192.167.4.0/24 table 45

    dhcp-hostname-flags

    -

    Flags for the DHCP hostname and FQDN. Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.

    +

    Flags for the DHCP hostname and FQDN.

    +

    Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6.

    +

    When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.

    Format: uint32

    @@ -2272,7 +2380,7 @@ Example: priority 5 from 192.167.4.0/24 table 45

    dhcp-iaid

    -

    A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.

    +

    A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.

    Format: string

    @@ -2280,7 +2388,7 @@ Example: priority 5 from 192.167.4.0/24 table 45

    dhcp-send-hostname

    -

    If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.

    +

    If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.

    Format: boolean

    @@ -2288,7 +2396,8 @@ Example: priority 5 from 192.167.4.0/24 table 45

    dhcp-timeout

    -

    A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). Set to 2147483647 (MAXINT32) for infinity.

    +

    A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds).

    +

    Set to 2147483647 (MAXINT32) for infinity.

    Format: int32

    @@ -2296,7 +2405,7 @@ Example: priority 5 from 192.167.4.0/24 table 45

    dns

    -

    Array of IP addresses of DNS servers.

    +

    Array of IP addresses of DNS servers.

    Format: array of byte array

    @@ -2304,7 +2413,11 @@ Example: priority 5 from 192.167.4.0/24 table 45

    dns-options

    -

    Array of DNS options as described in man 5 resolv.conf. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties. The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.

    +

    Array of DNS options as described in man 5 resolv.conf.

    +

    NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties.

    +

    The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc".

    +

    The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.

    +

    When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.

    Format: array of string

    @@ -2312,7 +2425,14 @@ Example: priority 5 from 192.167.4.0/24 table 45

    dns-priority

    -

    DNS servers priority. The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections. Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.

    +

    DNS servers priority.

    +

    The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).

    +

    Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.

    +

    Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections.

    +

    Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile.

    +

    When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices.

    +

    When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.

    +

    When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.

    Format: int32

    @@ -2320,7 +2440,9 @@ Example: priority 5 from 192.167.4.0/24 table 45

    dns-search

    -

    Array of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names. When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.

    +

    List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.

    +

    When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.

    +

    When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).

    Format: array of string

    @@ -2330,7 +2452,9 @@ Example: priority 5 from 192.167.4.0/24 table 45

    Alias: gw6

    -

    The gateway associated with this configuration. This is only meaningful if "addresses" is also set. The gateway's main purpose is to control the next hop of the standard default route on the device. Hence, the gateway property conflicts with "never-default" and will be automatically dropped if the IP configuration is set to never-default. As an alternative to set the gateway, configure a static default route with /0 as prefix length.

    +

    The gateway associated with this configuration. This is only meaningful if "addresses" is also set.

    +

    The gateway's main purpose is to control the next hop of the standard default route on the device. Hence, the gateway property conflicts with "never-default" and will be automatically dropped if the IP configuration is set to never-default.

    +

    As an alternative to set the gateway, configure a static default route with /0 as prefix length.

    Format: string

    @@ -2338,7 +2462,7 @@ Example: priority 5 from 192.167.4.0/24 table 45

    ignore-auto-dns

    -

    When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.

    +

    When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.

    Format: boolean

    @@ -2346,7 +2470,7 @@ Example: priority 5 from 192.167.4.0/24 table 45

    ignore-auto-routes

    -

    When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.

    +

    When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.

    Format: boolean

    @@ -2354,7 +2478,10 @@ Example: priority 5 from 192.167.4.0/24 table 45

    ip6-privacy

    -

    Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses). Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy". If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr". Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.

    +

    Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).

    +

    Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy".

    +

    If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr".

    +

    Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.

    Format: NMSettingIP6ConfigPrivacy (int32)

    @@ -2362,7 +2489,7 @@ Example: priority 5 from 192.167.4.0/24 table 45

    may-fail

    -

    If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.

    +

    If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.

    Format: boolean

    @@ -2370,15 +2497,27 @@ Example: priority 5 from 192.167.4.0/24 table 45

    method

    -

    IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.

    +

    IP configuration method.

    +

    NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values.

    +

    In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior.

    +

    For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty.

    +

    For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.

    Format: string

    +

    mtu

    + +

    Maximum transmission unit size, in bytes. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link-layer MTU. If greater than the link-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect.

    +

    + Format: uint32

    + + +

    never-default

    -

    If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.

    +

    If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.

    Format: boolean

    @@ -2386,7 +2525,8 @@ Example: priority 5 from 192.167.4.0/24 table 45

    ra-timeout

    -

    A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device. Set to 2147483647 (MAXINT32) for infinity.

    +

    A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device.

    +

    Set to 2147483647 (MAXINT32) for infinity.

    Format: int32

    @@ -2394,7 +2534,10 @@ Example: priority 5 from 192.167.4.0/24 table 45

    required-timeout

    -

    The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).

    +

    The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.

    +

    This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.

    +

    Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.

    +

    A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).

    Format: int32

    @@ -2402,7 +2545,7 @@ Example: priority 5 from 192.167.4.0/24 table 45

    route-metric

    -

    The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.

    +

    The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.

    Format: int64

    @@ -2410,7 +2553,10 @@ Example: priority 5 from 192.167.4.0/24 table 45

    route-table

    -

    Enable policy routing (source routing) and set the routing table used when adding routes. This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.

    +

    Enable policy routing (source routing) and set the routing table used when adding routes.

    +

    This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.

    +

    If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.

    +

    Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.

    Format: uint32

    @@ -2427,10 +2573,12 @@ next hop addresses, optional route metric, optional attribute. The valid syntax Various attributes are supported:

      +

    • "advmss" - an unsigned 32 bit integer.

    • "cwnd" - an unsigned 32 bit integer.

    • "from" - an IPv6 address with optional prefix. IPv6 only.

    • "initcwnd" - an unsigned 32 bit integer.

    • "initrwnd" - an unsigned 32 bit integer.

      • +

    • "lock-advmss" - a boolean value.

    • "lock-cwnd" - a boolean value.

    • "lock-initcwnd" - a boolean value.

    • "lock-initrwnd" - a boolean value.

      • @@ -2438,6 +2586,9 @@ Various attributes are supported:

    • "lock-window" - a boolean value.

    • "mtu" - an unsigned 32 bit integer.

    • "onlink" - a boolean value.

      • +

    • "quickack" - a boolean value.

      • +

    • "rto_min" - an unsigned 32 bit integer. +The value is in milliseconds.

    • "src" - an IPv6 address.

    • "table" - an unsigned 32 bit integer. The default depends on ipv6.route-table.

    • "type" - one of unicast, local, blackhole, @@ -2473,7 +2624,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      token

      -

      Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.

      +

      Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.

      Format: string

      @@ -2484,7 +2635,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      ip-tunnel setting

      -

      IP Tunneling Settings.

      +

      IP Tunneling Settings.

      Properties:

      @@ -2497,7 +2648,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      encapsulation-limit

      -

      How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.

      +

      How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.

      Format: uint32

      @@ -2505,7 +2656,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      flags

      -

      Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.

      +

      Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.

      Format: uint32

      @@ -2513,7 +2664,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      flow-label

      -

      The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.

      +

      The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.

      Format: uint32

      @@ -2521,7 +2672,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      input-key

      -

      The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.

      +

      The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.

      Format: string

      @@ -2531,7 +2682,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: local

      -

      The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.

      +

      The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.

      Format: string

      @@ -2541,7 +2692,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: mode

      -

      The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).

      +

      The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).

      Format: uint32

      @@ -2549,7 +2700,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      mtu

      -

      If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.

      +

      If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.

      Format: uint32

      @@ -2557,7 +2708,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      output-key

      -

      The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.

      +

      The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.

      Format: string

      @@ -2567,7 +2718,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: dev

      -

      If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.

      +

      If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.

      Format: string

      @@ -2575,7 +2726,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      path-mtu-discovery

      -

      Whether to enable Path MTU Discovery on this tunnel.

      +

      Whether to enable Path MTU Discovery on this tunnel.

      Format: boolean

      @@ -2585,7 +2736,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: remote

      -

      The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.

      +

      The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.

      Format: string

      @@ -2593,7 +2744,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      tos

      -

      The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.

      +

      The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.

      Format: uint32

      @@ -2601,7 +2752,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      ttl

      -

      The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.

      +

      The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.

      Format: uint32

      @@ -2612,7 +2763,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      macsec setting

      -

      MACSec Settings.

      +

      MACSec Settings.

      Properties:

      @@ -2627,7 +2778,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: encrypt

      -

      Whether the transmitted traffic must be encrypted.

      +

      Whether the transmitted traffic must be encrypted.

      Format: boolean

      @@ -2637,7 +2788,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: cak

      -

      The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement.

      +

      The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement.

      Format: string

      @@ -2645,9 +2796,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      mka-cak-flags

      -

      Flags indicating how to handle the "mka-cak" property. - See the section called “Secret flag types:” for flag values. -

      +

      Flags indicating how to handle the "mka-cak" property.

      Format: NMSettingSecretFlags (uint32)

      @@ -2657,7 +2806,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: ckn

      -

      The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement.

      +

      The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement.

      Format: string

      @@ -2667,7 +2816,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: mode

      -

      Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.

      +

      Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.

      Format: int32

      @@ -2677,7 +2826,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: dev

      -

      If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.

      +

      If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.

      Format: string

      @@ -2687,7 +2836,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: port

      -

      The port component of the SCI (Secure Channel Identifier), between 1 and 65534.

      +

      The port component of the SCI (Secure Channel Identifier), between 1 and 65534.

      Format: int32

      @@ -2695,7 +2844,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      send-sci

      -

      Specifies whether the SCI (Secure Channel Identifier) is included in every packet.

      +

      Specifies whether the SCI (Secure Channel Identifier) is included in every packet.

      Format: boolean

      @@ -2703,7 +2852,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      validation

      -

      Specifies the validation mode for incoming frames.

      +

      Specifies the validation mode for incoming frames.

      Format: int32

      @@ -2714,7 +2863,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      macvlan setting

      -

      MAC VLAN Settings.

      +

      MAC VLAN Settings.

      Properties:

      @@ -2729,7 +2878,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: mode

      -

      The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.

      +

      The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.

      Format: uint32

      @@ -2739,7 +2888,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: dev

      -

      If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.

      +

      If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.

      Format: string

      @@ -2747,7 +2896,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      promiscuous

      -

      Whether the interface should be put in promiscuous mode.

      +

      Whether the interface should be put in promiscuous mode.

      Format: boolean

      @@ -2757,7 +2906,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: tap

      -

      Whether the interface should be a MACVTAP.

      +

      Whether the interface should be a MACVTAP.

      Format: boolean

      @@ -2768,7 +2917,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      match setting

      -

      Match settings.

      +

      Match settings.

      Properties:

      @@ -2781,7 +2930,8 @@ Example: priority 5 from 1:2:3::5/128 table 45

      driver

      -

      A list of driver names to match. Each element is a shell wildcard pattern. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\' are used for optional and mandatory matches and inverting the pattern.

      +

      A list of driver names to match. Each element is a shell wildcard pattern.

      +

      See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.

      Format: array of string

      @@ -2789,7 +2939,8 @@ Example: priority 5 from 1:2:3::5/128 table 45

      interface-name

      -

      A list of interface names to match. Each element is a shell wildcard pattern. An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\!a" is an mandatory match for literally "!a".

      +

      A list of interface names to match. Each element is a shell wildcard pattern.

      +

      An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".

      Format: array of string

      @@ -2797,7 +2948,8 @@ Example: priority 5 from 1:2:3::5/128 table 45

      kernel-command-line

      -

      A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\' are used for optional and mandatory matches and inverting the match.

      +

      A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported.

      +

      See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.

      Format: array of string

      @@ -2805,7 +2957,11 @@ Example: priority 5 from 1:2:3::5/128 table 45

      path

      -

      A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier. For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0". The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev"). Each element of the list is a shell wildcard pattern. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\' are used for optional and mandatory matches and inverting the pattern.

      +

      A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier.

      +

      For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0".

      +

      The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev").

      +

      Each element of the list is a shell wildcard pattern.

      +

      See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.

      Format: array of string

      @@ -2818,7 +2974,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      802-11-olpc-mesh setting

      Alias: olpc-mesh

      -

      OLPC Wireless Mesh Settings.

      +

      OLPC Wireless Mesh Settings.

      Properties:

      @@ -2833,7 +2989,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: channel

      -

      Channel on which the mesh network to join is located.

      +

      Channel on which the mesh network to join is located.

      Format: uint32

      @@ -2843,7 +2999,8 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: dhcp-anycast

      -

      Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request. This is currently only implemented by dhclient DHCP plugin.

      +

      Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request.

      +

      This is currently only implemented by dhclient DHCP plugin.

      Format: byte array

      @@ -2853,7 +3010,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: ssid

      -

      SSID of the mesh network to join.

      +

      SSID of the mesh network to join.

      Format: byte array

      @@ -2864,7 +3021,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      ovs-bridge setting

      -

      OvsBridge Link Settings.

      +

      OvsBridge Link Settings.

      Properties:

      @@ -2877,7 +3034,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      datapath-type

      -

      The data path type. One of "system", "netdev" or empty.

      +

      The data path type. One of "system", "netdev" or empty.

      Format: string

      @@ -2885,7 +3042,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      fail-mode

      -

      The bridge failure mode. One of "secure", "standalone" or empty.

      +

      The bridge failure mode. One of "secure", "standalone" or empty.

      Format: string

      @@ -2893,7 +3050,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      mcast-snooping-enable

      -

      Enable or disable multicast snooping.

      +

      Enable or disable multicast snooping.

      Format: boolean

      @@ -2901,7 +3058,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      rstp-enable

      -

      Enable or disable RSTP.

      +

      Enable or disable RSTP.

      Format: boolean

      @@ -2909,7 +3066,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      stp-enable

      -

      Enable or disable STP.

      +

      Enable or disable STP.

      Format: boolean

      @@ -2920,7 +3077,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      ovs-dpdk setting

      -

      OvsDpdk Link Settings.

      +

      OvsDpdk Link Settings.

      Properties:

      @@ -2933,7 +3090,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      devargs

      -

      Open vSwitch DPDK device arguments.

      +

      Open vSwitch DPDK device arguments.

      Format: string

      @@ -2941,7 +3098,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      n-rxq

      -

      Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.

      +

      Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.

      Format: uint32

      @@ -2952,7 +3109,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      ovs-interface setting

      -

      Open vSwitch Interface Settings.

      +

      Open vSwitch Interface Settings.

      Properties:

      @@ -2964,7 +3121,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      type

      -

      The interface type. Either "internal", "system", "patch", "dpdk", or empty.

      +

      The interface type. Either "internal", "system", "patch", "dpdk", or empty.

      Format: string

      @@ -2974,7 +3131,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      ovs-patch setting

      -

      OvsPatch Link Settings.

      +

      OvsPatch Link Settings.

      Properties:

      @@ -2986,7 +3143,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      peer

      -

      Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.

      +

      Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.

      Format: string

      @@ -2996,7 +3153,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      ovs-port setting

      -

      OvsPort Link Settings.

      +

      OvsPort Link Settings.

      Properties:

      @@ -3009,7 +3166,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      bond-downdelay

      -

      The time port must be inactive in order to be considered down.

      +

      The time port must be inactive in order to be considered down.

      Format: uint32

      @@ -3017,7 +3174,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      bond-mode

      -

      Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".

      +

      Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".

      Format: string

      @@ -3025,7 +3182,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      bond-updelay

      -

      The time port must be active before it starts forwarding traffic.

      +

      The time port must be active before it starts forwarding traffic.

      Format: uint32

      @@ -3033,7 +3190,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      lacp

      -

      LACP mode. One of "active", "off", or "passive".

      +

      LACP mode. One of "active", "off", or "passive".

      Format: string

      @@ -3041,7 +3198,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      tag

      -

      The VLAN tag in the range 0-4095.

      +

      The VLAN tag in the range 0-4095.

      Format: uint32

      @@ -3049,7 +3206,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      vlan-mode

      -

      The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk" or unset.

      +

      The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk" or unset.

      Format: string

      @@ -3060,7 +3217,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      ppp setting

      -

      Point-to-Point Protocol Settings.

      +

      Point-to-Point Protocol Settings.

      Properties:

      @@ -3073,7 +3230,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      baud

      -

      If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.

      +

      If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.

      Format: uint32

      @@ -3081,7 +3238,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      crtscts

      -

      If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.

      +

      If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.

      Format: boolean

      @@ -3089,7 +3246,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      lcp-echo-failure

      -

      If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.

      +

      If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.

      Format: uint32

      @@ -3097,7 +3254,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      lcp-echo-interval

      -

      If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.

      +

      If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.

      Format: uint32

      @@ -3105,7 +3262,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      mppe-stateful

      -

      If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.

      +

      If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.

      Format: boolean

      @@ -3113,7 +3270,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      mru

      -

      If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.

      +

      If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.

      Format: uint32

      @@ -3121,7 +3278,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      mtu

      -

      If non-zero, instruct pppd to send packets no larger than the specified size.

      +

      If non-zero, instruct pppd to send packets no larger than the specified size.

      Format: uint32

      @@ -3129,7 +3286,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      no-vj-comp

      -

      If TRUE, Van Jacobsen TCP header compression will not be requested.

      +

      If TRUE, Van Jacobsen TCP header compression will not be requested.

      Format: boolean

      @@ -3137,7 +3294,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      noauth

      -

      If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.

      +

      If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.

      Format: boolean

      @@ -3145,7 +3302,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      nobsdcomp

      -

      If TRUE, BSD compression will not be requested.

      +

      If TRUE, BSD compression will not be requested.

      Format: boolean

      @@ -3153,7 +3310,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      nodeflate

      -

      If TRUE, "deflate" compression will not be requested.

      +

      If TRUE, "deflate" compression will not be requested.

      Format: boolean

      @@ -3161,7 +3318,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      refuse-chap

      -

      If TRUE, the CHAP authentication method will not be used.

      +

      If TRUE, the CHAP authentication method will not be used.

      Format: boolean

      @@ -3169,7 +3326,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      refuse-eap

      -

      If TRUE, the EAP authentication method will not be used.

      +

      If TRUE, the EAP authentication method will not be used.

      Format: boolean

      @@ -3177,7 +3334,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      refuse-mschap

      -

      If TRUE, the MSCHAP authentication method will not be used.

      +

      If TRUE, the MSCHAP authentication method will not be used.

      Format: boolean

      @@ -3185,7 +3342,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      refuse-mschapv2

      -

      If TRUE, the MSCHAPv2 authentication method will not be used.

      +

      If TRUE, the MSCHAPv2 authentication method will not be used.

      Format: boolean

      @@ -3193,7 +3350,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      refuse-pap

      -

      If TRUE, the PAP authentication method will not be used.

      +

      If TRUE, the PAP authentication method will not be used.

      Format: boolean

      @@ -3201,7 +3358,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      require-mppe

      -

      If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.

      +

      If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.

      Format: boolean

      @@ -3209,7 +3366,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      require-mppe-128

      -

      If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.

      +

      If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.

      Format: boolean

      @@ -3220,7 +3377,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      pppoe setting

      -

      PPP-over-Ethernet Settings.

      +

      PPP-over-Ethernet Settings.

      Properties:

      @@ -3235,7 +3392,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: parent

      -

      If given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.

      +

      If given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.

      Format: string

      @@ -3245,7 +3402,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: password

      -

      Password used to authenticate with the PPPoE service.

      +

      Password used to authenticate with the PPPoE service.

      Format: string

      @@ -3253,9 +3410,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      password-flags

      -

      Flags indicating how to handle the "password" property. - See the section called “Secret flag types:” for flag values. -

      +

      Flags indicating how to handle the "password" property.

      Format: NMSettingSecretFlags (uint32)

      @@ -3265,7 +3420,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: service

      -

      If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.

      +

      If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.

      Format: string

      @@ -3275,7 +3430,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: username

      -

      Username used to authenticate with the PPPoE service.

      +

      Username used to authenticate with the PPPoE service.

      Format: string

      @@ -3286,7 +3441,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      proxy setting

      -

      WWW Proxy Settings.

      +

      WWW Proxy Settings.

      Properties:

      @@ -3301,7 +3456,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: browser-only

      -

      Whether the proxy configuration is for browser only.

      +

      Whether the proxy configuration is for browser only.

      Format: boolean

      @@ -3311,7 +3466,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: method

      -

      Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)

      +

      Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)

      Format: int32

      @@ -3321,7 +3476,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: pac-script

      -

      The PAC script. In the profile this must be an UTF-8 encoded javascript code that defines a FindProxyForURL() function. When setting the property in nmcli, a filename is accepted too. In that case, nmcli will read the content of the file and set the script. The prefixes "file://" and "js://" are supported to explicitly differentiate between the two.

      +

      PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.

      Format: string

      @@ -3331,7 +3486,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      Alias: pac-url

      -

      PAC URL for obtaining PAC file.

      +

      PAC URL for obtaining PAC file.

      Format: string

      @@ -3342,7 +3497,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      serial setting

      -

      Serial Link Settings.

      +

      Serial Link Settings.

      Properties:

      @@ -3355,7 +3510,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      baud

      -

      Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.

      +

      Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.

      Format: uint32

      @@ -3363,7 +3518,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      bits

      -

      Byte-width of the serial communication. The 8 in "8n1" for example.

      +

      Byte-width of the serial communication. The 8 in "8n1" for example.

      Format: uint32

      @@ -3371,7 +3526,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      parity

      -

      Parity setting of the serial port.

      +

      Parity setting of the serial port.

      Format: NMSettingSerialParity (byte)

      @@ -3379,7 +3534,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      send-delay

      -

      Time to delay between each byte sent to the modem, in microseconds.

      +

      Time to delay between each byte sent to the modem, in microseconds.

      Format: uint64

      @@ -3387,7 +3542,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      stopbits

      -

      Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.

      +

      Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.

      Format: uint32

      @@ -3398,7 +3553,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      sriov setting

      -

      SR-IOV settings.

      +

      SR-IOV settings.

      Properties:

      @@ -3411,7 +3566,10 @@ Example: priority 5 from 1:2:3::5/128 table 45

      autoprobe-drivers

      -

      Whether to autoprobe virtual functions by a compatible driver. If set to NM_TERNARY_TRUE (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF. If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them. When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_TRUE (1).

      +

      Whether to autoprobe virtual functions by a compatible driver.

      +

      If set to NM_TERNARY_TRUE (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF.

      +

      If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them.

      +

      When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_TRUE (1).

      Format: NMTernary (int32)

      @@ -3419,7 +3577,8 @@ Example: priority 5 from 1:2:3::5/128 table 45

      total-vfs

      -

      The total number of virtual functions to create. Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.

      +

      The total number of virtual functions to create.

      +

      Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.

      Format: uint32

      @@ -3427,7 +3586,16 @@ Example: priority 5 from 1:2:3::5/128 table 45

      vfs

      -

      Array of virtual function descriptors. Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF. When represented as string a VF is in the form: "INDEX [ATTR=VALUE[ ATTR=VALUE]...]". for example: "2 mac=00:11:22:33:44:55 spoof-check=true". Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans. The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form "ID[.PRIORITY[.PROTO]]". PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.

      +

      Array of virtual function descriptors.

      +

      Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF.

      +

      When represented as string a VF is in the form:

      +

      "INDEX [ATTR=VALUE[ ATTR=VALUE]...]".

      +

      for example:

      +

      "2 mac=00:11:22:33:44:55 spoof-check=true".

      +

      Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans.

      +

      The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form

      +

      "ID[.PRIORITY[.PROTO]]".

      +

      PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.

      Format: array of vardict

      @@ -3438,7 +3606,7 @@ Example: priority 5 from 1:2:3::5/128 table 45

      tc setting

      -

      Linux Traffic Control Settings.

      +

      Linux Traffic Control Settings.

      Properties:

      @@ -3815,7 +3983,7 @@ The actual string to print.

      team setting

      -

      Teaming Settings.

      +

      Teaming Settings.

      Properties:

      @@ -3830,7 +3998,7 @@ The actual string to print.

      Alias: config

      -

      The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.

      +

      The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.

      Format: string

      @@ -3838,7 +4006,7 @@ The actual string to print.

      link-watchers

      -

      Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.

      +

      Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.

      Format: array of vardict

      @@ -3846,7 +4014,7 @@ The actual string to print.

      mcast-rejoin-count

      -

      Corresponds to the teamd mcast_rejoin.count.

      +

      Corresponds to the teamd mcast_rejoin.count.

      Format: int32

      @@ -3854,7 +4022,7 @@ The actual string to print.

      mcast-rejoin-interval

      -

      Corresponds to the teamd mcast_rejoin.interval.

      +

      Corresponds to the teamd mcast_rejoin.interval.

      Format: int32

      @@ -3862,7 +4030,7 @@ The actual string to print.

      notify-peers-count

      -

      Corresponds to the teamd notify_peers.count.

      +

      Corresponds to the teamd notify_peers.count.

      Format: int32

      @@ -3870,7 +4038,7 @@ The actual string to print.

      notify-peers-interval

      -

      Corresponds to the teamd notify_peers.interval.

      +

      Corresponds to the teamd notify_peers.interval.

      Format: int32

      @@ -3878,7 +4046,7 @@ The actual string to print.

      runner

      -

      Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".

      +

      Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".

      Format: string

      @@ -3886,7 +4054,7 @@ The actual string to print.

      runner-active

      -

      Corresponds to the teamd runner.active.

      +

      Corresponds to the teamd runner.active.

      Format: boolean

      @@ -3894,7 +4062,7 @@ The actual string to print.

      runner-agg-select-policy

      -

      Corresponds to the teamd runner.agg_select_policy.

      +

      Corresponds to the teamd runner.agg_select_policy.

      Format: string

      @@ -3902,7 +4070,7 @@ The actual string to print.

      runner-fast-rate

      -

      Corresponds to the teamd runner.fast_rate.

      +

      Corresponds to the teamd runner.fast_rate.

      Format: boolean

      @@ -3910,7 +4078,7 @@ The actual string to print.

      runner-hwaddr-policy

      -

      Corresponds to the teamd runner.hwaddr_policy.

      +

      Corresponds to the teamd runner.hwaddr_policy.

      Format: string

      @@ -3918,7 +4086,7 @@ The actual string to print.

      runner-min-ports

      -

      Corresponds to the teamd runner.min_ports.

      +

      Corresponds to the teamd runner.min_ports.

      Format: int32

      @@ -3926,7 +4094,7 @@ The actual string to print.

      runner-sys-prio

      -

      Corresponds to the teamd runner.sys_prio.

      +

      Corresponds to the teamd runner.sys_prio.

      Format: int32

      @@ -3934,7 +4102,7 @@ The actual string to print.

      runner-tx-balancer

      -

      Corresponds to the teamd runner.tx_balancer.name.

      +

      Corresponds to the teamd runner.tx_balancer.name.

      Format: string

      @@ -3942,7 +4110,7 @@ The actual string to print.

      runner-tx-balancer-interval

      -

      Corresponds to the teamd runner.tx_balancer.interval.

      +

      Corresponds to the teamd runner.tx_balancer.interval.

      Format: int32

      @@ -3950,7 +4118,7 @@ The actual string to print.

      runner-tx-hash

      -

      Corresponds to the teamd runner.tx_hash.

      +

      Corresponds to the teamd runner.tx_hash.

      Format: array of string

      @@ -3961,7 +4129,7 @@ The actual string to print.

      team-port setting

      -

      Team Port Settings.

      +

      Team Port Settings.

      Properties:

      @@ -3976,7 +4144,7 @@ The actual string to print.

      Alias: config

      -

      The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.

      +

      The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.

      Format: string

      @@ -3984,7 +4152,7 @@ The actual string to print.

      lacp-key

      -

      Corresponds to the teamd ports.PORTIFNAME.lacp_key.

      +

      Corresponds to the teamd ports.PORTIFNAME.lacp_key.

      Format: int32

      @@ -3992,7 +4160,7 @@ The actual string to print.

      lacp-prio

      -

      Corresponds to the teamd ports.PORTIFNAME.lacp_prio.

      +

      Corresponds to the teamd ports.PORTIFNAME.lacp_prio.

      Format: int32

      @@ -4000,7 +4168,7 @@ The actual string to print.

      link-watchers

      -

      Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.

      +

      Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.

      Format: array of vardict

      @@ -4008,7 +4176,7 @@ The actual string to print.

      prio

      -

      Corresponds to the teamd ports.PORTIFNAME.prio.

      +

      Corresponds to the teamd ports.PORTIFNAME.prio.

      Format: int32

      @@ -4016,7 +4184,7 @@ The actual string to print.

      queue-id

      -

      Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.

      +

      Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.

      Format: int32

      @@ -4024,7 +4192,7 @@ The actual string to print.

      sticky

      -

      Corresponds to the teamd ports.PORTIFNAME.sticky.

      +

      Corresponds to the teamd ports.PORTIFNAME.sticky.

      Format: boolean

      @@ -4035,7 +4203,7 @@ The actual string to print.

      tun setting

      -

      Tunnel Settings.

      +

      Tunnel Settings.

      Properties:

      @@ -4050,7 +4218,7 @@ The actual string to print.

      Alias: group

      -

      The group ID which will own the device. If set to NULL everyone will be able to use the device.

      +

      The group ID which will own the device. If set to NULL everyone will be able to use the device.

      Format: string

      @@ -4060,7 +4228,7 @@ The actual string to print.

      Alias: mode

      -

      The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.

      +

      The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.

      Format: uint32

      @@ -4070,7 +4238,7 @@ The actual string to print.

      Alias: multi-queue

      -

      If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.

      +

      If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.

      Format: boolean

      @@ -4080,7 +4248,7 @@ The actual string to print.

      Alias: owner

      -

      The user ID which will own the device. If set to NULL everyone will be able to use the device.

      +

      The user ID which will own the device. If set to NULL everyone will be able to use the device.

      Format: string

      @@ -4090,7 +4258,7 @@ The actual string to print.

      Alias: pi

      -

      If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.

      +

      If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.

      Format: boolean

      @@ -4100,7 +4268,7 @@ The actual string to print.

      Alias: vnet-hdr

      -

      If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.

      +

      If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.

      Format: boolean

      @@ -4111,7 +4279,7 @@ The actual string to print.

      vlan setting

      -

      VLAN Settings.

      +

      VLAN Settings.

      Properties:

      @@ -4126,7 +4294,7 @@ The actual string to print.

      Alias: egress

      -

      For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".

      +

      For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".

      Format: array of string

      @@ -4136,7 +4304,8 @@ The actual string to print.

      Alias: flags

      -

      One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol). The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.

      +

      One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol).

      +

      The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.

      Format: NMVlanFlags (uint32)

      @@ -4146,7 +4315,7 @@ The actual string to print.

      Alias: id

      -

      The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.

      +

      The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.

      Format: uint32

      @@ -4156,7 +4325,7 @@ The actual string to print.

      Alias: ingress

      -

      For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".

      +

      For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".

      Format: array of string

      @@ -4166,7 +4335,7 @@ The actual string to print.

      Alias: dev

      -

      If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.

      +

      If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.

      Format: string

      @@ -4177,7 +4346,7 @@ The actual string to print.

      vpn setting

      -

      VPN Settings.

      +

      VPN Settings.

      Properties:

      @@ -4190,7 +4359,7 @@ The actual string to print.

      data

      -

      Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.

      +

      Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.

      Format: dict of string to string

      @@ -4198,7 +4367,7 @@ The actual string to print.

      persistent

      -

      If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.

      +

      If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.

      Format: boolean

      @@ -4206,7 +4375,7 @@ The actual string to print.

      secrets

      -

      Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.

      +

      Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.

      Format: dict of string to string

      @@ -4216,7 +4385,7 @@ The actual string to print.

      Alias: vpn-type

      -

      D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.

      +

      D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.

      Format: string

      @@ -4224,7 +4393,7 @@ The actual string to print.

      timeout

      -

      Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overridden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.

      +

      Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overridden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.

      Format: uint32

      @@ -4234,7 +4403,7 @@ The actual string to print.

      Alias: user

      -

      If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.

      +

      If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.

      Format: string

      @@ -4245,7 +4414,7 @@ The actual string to print.

      vrf setting

      -

      VRF settings.

      +

      VRF settings.

      Properties:

      @@ -4259,7 +4428,7 @@ The actual string to print.

      Alias: table

      -

      The routing table for this VRF.

      +

      The routing table for this VRF.

      Format: uint32

      @@ -4269,7 +4438,7 @@ The actual string to print.

      vxlan setting

      -

      VXLAN Settings.

      +

      VXLAN Settings.

      Properties:

      @@ -4282,7 +4451,7 @@ The actual string to print.

      ageing

      -

      Specifies the lifetime in seconds of FDB entries learnt by the kernel.

      +

      Specifies the lifetime in seconds of FDB entries learnt by the kernel.

      Format: uint32

      @@ -4292,7 +4461,7 @@ The actual string to print.

      Alias: destination-port

      -

      Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.

      +

      Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.

      Format: uint32

      @@ -4302,7 +4471,7 @@ The actual string to print.

      Alias: id

      -

      Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.

      +

      Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.

      Format: uint32

      @@ -4310,7 +4479,7 @@ The actual string to print.

      l2-miss

      -

      Specifies whether netlink LL ADDR miss notifications are generated.

      +

      Specifies whether netlink LL ADDR miss notifications are generated.

      Format: boolean

      @@ -4318,7 +4487,7 @@ The actual string to print.

      l3-miss

      -

      Specifies whether netlink IP ADDR miss notifications are generated.

      +

      Specifies whether netlink IP ADDR miss notifications are generated.

      Format: boolean

      @@ -4326,7 +4495,7 @@ The actual string to print.

      learning

      -

      Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.

      +

      Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.

      Format: boolean

      @@ -4334,7 +4503,7 @@ The actual string to print.

      limit

      -

      Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.

      +

      Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.

      Format: uint32

      @@ -4344,7 +4513,7 @@ The actual string to print.

      Alias: local

      -

      If given, specifies the source IP address to use in outgoing packets.

      +

      If given, specifies the source IP address to use in outgoing packets.

      Format: string

      @@ -4354,7 +4523,7 @@ The actual string to print.

      Alias: dev

      -

      If given, specifies the parent interface name or parent connection UUID.

      +

      If given, specifies the parent interface name or parent connection UUID.

      Format: string

      @@ -4362,7 +4531,7 @@ The actual string to print.

      proxy

      -

      Specifies whether ARP proxy is turned on.

      +

      Specifies whether ARP proxy is turned on.

      Format: boolean

      @@ -4372,7 +4541,7 @@ The actual string to print.

      Alias: remote

      -

      Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.

      +

      Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.

      Format: string

      @@ -4380,7 +4549,7 @@ The actual string to print.

      rsc

      -

      Specifies whether route short circuit is turned on.

      +

      Specifies whether route short circuit is turned on.

      Format: boolean

      @@ -4390,7 +4559,7 @@ The actual string to print.

      Alias: source-port-max

      -

      Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.

      +

      Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.

      Format: uint32

      @@ -4400,7 +4569,7 @@ The actual string to print.

      Alias: source-port-min

      -

      Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.

      +

      Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.

      Format: uint32

      @@ -4408,7 +4577,7 @@ The actual string to print.

      tos

      -

      Specifies the TOS value to use in outgoing packets.

      +

      Specifies the TOS value to use in outgoing packets.

      Format: uint32

      @@ -4416,7 +4585,7 @@ The actual string to print.

      ttl

      -

      Specifies the time-to-live value to use in outgoing packets.

      +

      Specifies the time-to-live value to use in outgoing packets.

      Format: uint32

      @@ -4427,7 +4596,7 @@ The actual string to print.

      wifi-p2p setting

      -

      Wi-Fi P2P Settings.

      +

      Wi-Fi P2P Settings.

      Properties:

      @@ -4442,7 +4611,7 @@ The actual string to print.

      Alias: peer

      -

      The P2P device that should be connected to. Currently, this is the only way to create or join a group.

      +

      The P2P device that should be connected to. Currently, this is the only way to create or join a group.

      Format: string

      @@ -4450,7 +4619,8 @@ The actual string to print.

      wfd-ies

      -

      The Wi-Fi Display (WFD) Information Elements (IEs) to set. Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.

      +

      The Wi-Fi Display (WFD) Information Elements (IEs) to set.

      +

      Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.

      Format: byte array

      @@ -4458,7 +4628,8 @@ The actual string to print.

      wps-method

      -

      Flags indicating which mode of WPS is to be used. There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.

      +

      Flags indicating which mode of WPS is to be used.

      +

      There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.

      Format: uint32

      @@ -4469,7 +4640,7 @@ The actual string to print.

      wimax setting

      -

      WiMax Settings.

      +

      WiMax Settings.

      Properties:

      @@ -4484,7 +4655,7 @@ The actual string to print.

      Alias: mac

      -

      If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing). Deprecated: 1

      +

      If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing). Deprecated: 1

      Format: byte array

      @@ -4494,7 +4665,7 @@ The actual string to print.

      Alias: nsp

      -

      Network Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1

      +

      Network Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1

      Format: string

      @@ -4507,7 +4678,7 @@ The actual string to print.

      802-3-ethernet setting

      Alias: ethernet

      -

      Wired Ethernet Settings.

      +

      Wired Ethernet Settings.

      Properties:

      @@ -4520,7 +4691,7 @@ The actual string to print.

      accept-all-mac-addresses

      -

      When TRUE, setup the interface to accept packets for all MAC addresses. This is enabling the kernel interface flag IFF_PROMISC. When FALSE, the interface will only accept the packets with the interface destination mac address or broadcast.

      +

      When TRUE, setup the interface to accept packets for all MAC addresses. This is enabling the kernel interface flag IFF_PROMISC. When FALSE, the interface will only accept the packets with the interface destination mac address or broadcast.

      Format: NMTernary (int32)

      @@ -4528,7 +4699,7 @@ The actual string to print.

      auto-negotiate

      -

      When TRUE, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped.

      +

      When TRUE, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped.

      Format: boolean

      @@ -4538,7 +4709,10 @@ The actual string to print.

      Alias: cloned-mac

      -

      If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing. Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address if the device has one (otherwise this is treated as "preserve"). "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key. If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value). On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".

      +

      If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.

      +

      Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address if the device has one (otherwise this is treated as "preserve"). "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key.

      +

      If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).

      +

      On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".

      Format: byte array

      @@ -4546,7 +4720,7 @@ The actual string to print.

      duplex

      -

      When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.

      +

      When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.

      Format: string

      @@ -4554,7 +4728,11 @@ The actual string to print.

      generate-mac-address-mask

      -

      With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.

      +

      With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.

      +

      If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address.

      +

      If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm.

      +

      If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address.

      +

      If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.

      Format: string

      @@ -4564,7 +4742,7 @@ The actual string to print.

      Alias: mac

      -

      If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).

      +

      If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).

      Format: byte array

      @@ -4572,7 +4750,7 @@ The actual string to print.

      mac-address-blacklist

      -

      If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).

      +

      If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).

      Format: array of string

      @@ -4582,7 +4760,7 @@ The actual string to print.

      Alias: mtu

      -

      If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.

      +

      If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.

      Format: uint32

      @@ -4590,7 +4768,7 @@ The actual string to print.

      port

      -

      Specific port type to use if the device supports multiple attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored.

      +

      Specific port type to use if the device supports multiple attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored.

      Format: string

      @@ -4598,7 +4776,7 @@ The actual string to print.

      s390-nettype

      -

      s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.

      +

      s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.

      Format: string

      @@ -4606,7 +4784,8 @@ The actual string to print.

      s390-options

      -

      Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]). Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.

      +

      Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).

      +

      Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.

      Format: dict of string to string

      @@ -4614,7 +4793,7 @@ The actual string to print.

      s390-subchannels

      -

      Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.

      +

      Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.

      Format: array of string

      @@ -4622,7 +4801,7 @@ The actual string to print.

      speed

      -

      When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.

      +

      When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.

      Format: uint32

      @@ -4630,7 +4809,7 @@ The actual string to print.

      wake-on-lan

      -

      The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).

      +

      The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).

      Format: uint32

      @@ -4638,7 +4817,7 @@ The actual string to print.

      wake-on-lan-password

      -

      If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required.

      +

      If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required.

      Format: string

      @@ -4649,7 +4828,7 @@ The actual string to print.

      wireguard setting

      -

      WireGuard Settings.

      +

      WireGuard Settings.

      Properties:

      @@ -4662,7 +4841,8 @@ The actual string to print.

      fwmark

      -

      The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets. Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.

      +

      The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets.

      +

      Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.

      Format: uint32

      @@ -4670,7 +4850,9 @@ The actual string to print.

      ip4-auto-default-route

      -

      Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing". Note that for this automatism to work, you usually don't want to set ipv4.gateway, because that will result in a conflicting default route. Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips.

      +

      Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing".

      +

      Note that for this automatism to work, you usually don't want to set ipv4.gateway, because that will result in a conflicting default route.

      +

      Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.

      Format: NMTernary (int32)

      @@ -4678,7 +4860,7 @@ The actual string to print.

      ip6-auto-default-route

      -

      Like ip4-auto-default-route, but for the IPv6 default route.

      +

      Like ip4-auto-default-route, but for the IPv6 default route.

      Format: NMTernary (int32)

      @@ -4686,7 +4868,7 @@ The actual string to print.

      listen-port

      -

      The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.

      +

      The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.

      Format: uint32

      @@ -4694,7 +4876,8 @@ The actual string to print.

      mtu

      -

      If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments. If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation.

      +

      If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.

      +

      If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation.

      Format: uint32

      @@ -4702,7 +4885,8 @@ The actual string to print.

      peer-routes

      -

      Whether to automatically add routes for the AllowedIPs ranges of the peers. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If FALSE, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively. Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically.

      +

      Whether to automatically add routes for the AllowedIPs ranges of the peers. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If FALSE, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively.

      +

      Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically.

      Format: boolean

      @@ -4710,7 +4894,7 @@ The actual string to print.

      private-key

      -

      The 256 bit private-key in base64 encoding.

      +

      The 256 bit private-key in base64 encoding.

      Format: string

      @@ -4718,9 +4902,7 @@ The actual string to print.

      private-key-flags

      -

      Flags indicating how to handle the "private-key" property. - See the section called “Secret flag types:” for flag values. -

      +

      Flags indicating how to handle the "private-key" property.

      Format: NMSettingSecretFlags (uint32)

      @@ -4733,7 +4915,7 @@ The actual string to print.

      802-11-wireless setting

      Alias: wifi

      -

      Wi-Fi Settings.

      +

      Wi-Fi Settings.

      Properties:

      @@ -4746,7 +4928,10 @@ The actual string to print.

      ap-isolation

      -

      Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from NM_TERNARY_DEFAULT (-1) only when the interface is configured in AP mode. If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc. If set to NM_TERNARY_FALSE (0), devices can talk to each other. When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_FALSE (0).

      +

      Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from NM_TERNARY_DEFAULT (-1) only when the interface is configured in AP mode.

      +

      If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc.

      +

      If set to NM_TERNARY_FALSE (0), devices can talk to each other.

      +

      When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_FALSE (0).

      Format: NMTernary (int32)

      @@ -4754,7 +4939,7 @@ The actual string to print.

      band

      -

      802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.

      +

      802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.

      Format: string

      @@ -4762,7 +4947,8 @@ The actual string to print.

      bssid

      -

      If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.

      +

      If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.

      +

      Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.

      Format: byte array

      @@ -4770,7 +4956,7 @@ The actual string to print.

      channel

      -

      Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.

      +

      Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.

      Format: uint32

      @@ -4780,7 +4966,10 @@ The actual string to print.

      Alias: cloned-mac

      -

      If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing. Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address of the device. "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key. If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value). On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".

      +

      If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.

      +

      Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address of the device. "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key.

      +

      If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).

      +

      On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".

      Format: byte array

      @@ -4788,7 +4977,11 @@ The actual string to print.

      generate-mac-address-mask

      -

      With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.

      +

      With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.

      +

      If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address.

      +

      If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm.

      +

      If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address.

      +

      If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.

      Format: string

      @@ -4796,7 +4989,10 @@ The actual string to print.

      hidden

      -

      If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode. In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution. In AP mode, the created network does not broadcast its SSID. Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.

      +

      If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode.

      +

      In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.

      +

      In AP mode, the created network does not broadcast its SSID.

      +

      Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.

      Format: boolean

      @@ -4806,7 +5002,7 @@ The actual string to print.

      Alias: mac

      -

      If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).

      +

      If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).

      Format: byte array

      @@ -4814,7 +5010,7 @@ The actual string to print.

      mac-address-blacklist

      -

      A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").

      +

      A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").

      Format: array of string

      @@ -4822,7 +5018,7 @@ The actual string to print.

      mac-address-randomization

      -

      One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address). This property is deprecated for 'cloned-mac-address'. Deprecated: 1

      +

      One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address). This property is deprecated for 'cloned-mac-address'. Deprecated: 1

      Format: uint32

      @@ -4832,7 +5028,7 @@ The actual string to print.

      Alias: mode

      -

      Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.

      +

      Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.

      Format: string

      @@ -4842,7 +5038,7 @@ The actual string to print.

      Alias: mtu

      -

      If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.

      +

      If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.

      Format: uint32

      @@ -4850,7 +5046,7 @@ The actual string to print.

      powersave

      -

      One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.

      +

      One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.

      Format: uint32

      @@ -4858,7 +5054,7 @@ The actual string to print.

      rate

      -

      If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.

      +

      If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.

      Format: uint32

      @@ -4866,7 +5062,7 @@ The actual string to print.

      seen-bssids

      -

      A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.

      +

      A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.

      Format: array of string

      @@ -4876,7 +5072,7 @@ The actual string to print.

      Alias: ssid

      -

      SSID of the Wi-Fi network. Must be specified.

      +

      SSID of the Wi-Fi network. Must be specified.

      Format: byte array

      @@ -4884,7 +5080,7 @@ The actual string to print.

      tx-power

      -

      If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.

      +

      If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.

      Format: uint32

      @@ -4892,7 +5088,7 @@ The actual string to print.

      wake-on-wlan

      -

      The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).

      +

      The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).

      Format: uint32

      @@ -4905,7 +5101,7 @@ The actual string to print.

      802-11-wireless-security setting

      Alias: wifi-sec

      -

      Wi-Fi Security Settings.

      +

      Wi-Fi Security Settings.

      Properties:

      @@ -4918,7 +5114,7 @@ The actual string to print.

      auth-alg

      -

      When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.

      +

      When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.

      Format: string

      @@ -4926,7 +5122,7 @@ The actual string to print.

      fils

      -

      Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (1) (disable FILS), NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (2) (enable FILS if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (3) (enable FILS and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) and no global default is set, FILS will be optionally enabled.

      +

      Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (1) (disable FILS), NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (2) (enable FILS if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (3) (enable FILS and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) and no global default is set, FILS will be optionally enabled.

      Format: int32

      @@ -4934,7 +5130,7 @@ The actual string to print.

      group

      -

      A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".

      +

      A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".

      Format: array of string

      @@ -4942,7 +5138,8 @@ The actual string to print.

      key-mgmt

      -

      Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only). This property must be set for any Wi-Fi connection that uses security.

      +

      Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only).

      +

      This property must be set for any Wi-Fi connection that uses security.

      Format: string

      @@ -4950,7 +5147,7 @@ The actual string to print.

      leap-password

      -

      The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").

      +

      The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").

      Format: string

      @@ -4958,9 +5155,7 @@ The actual string to print.

      leap-password-flags

      -

      Flags indicating how to handle the "leap-password" property. - See the section called “Secret flag types:” for flag values. -

      +

      Flags indicating how to handle the "leap-password" property.

      Format: NMSettingSecretFlags (uint32)

      @@ -4968,7 +5163,7 @@ The actual string to print.

      leap-username

      -

      The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").

      +

      The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").

      Format: string

      @@ -4976,7 +5171,7 @@ The actual string to print.

      pairwise

      -

      A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "tkip" or "ccmp".

      +

      A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "tkip" or "ccmp".

      Format: array of string

      @@ -4984,7 +5179,7 @@ The actual string to print.

      pmf

      -

      Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE (1) (disable PMF), NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL (2) (enable PMF if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED (3) (enable PMF and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) and no global default is set, PMF will be optionally enabled.

      +

      Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE (1) (disable PMF), NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL (2) (enable PMF if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED (3) (enable PMF and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) and no global default is set, PMF will be optionally enabled.

      Format: int32

      @@ -4992,7 +5187,7 @@ The actual string to print.

      proto

      -

      List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.

      +

      List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.

      Format: array of string

      @@ -5000,7 +5195,7 @@ The actual string to print.

      psk

      -

      Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication.

      +

      Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication.

      Format: string

      @@ -5008,9 +5203,7 @@ The actual string to print.

      psk-flags

      -

      Flags indicating how to handle the "psk" property. - See the section called “Secret flag types:” for flag values. -

      +

      Flags indicating how to handle the "psk" property.

      Format: NMSettingSecretFlags (uint32)

      @@ -5018,9 +5211,7 @@ The actual string to print.

      wep-key-flags

      -

      Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties. - See the section called “Secret flag types:” for flag values. -

      +

      Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.

      Format: NMSettingSecretFlags (uint32)

      @@ -5028,7 +5219,7 @@ The actual string to print.

      wep-key-type

      -

      Controls the interpretation of WEP keys. Allowed values are NM_WEP_KEY_TYPE_KEY (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or NM_WEP_KEY_TYPE_PASSPHRASE (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.

      +

      Controls the interpretation of WEP keys. Allowed values are NM_WEP_KEY_TYPE_KEY (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or NM_WEP_KEY_TYPE_PASSPHRASE (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.

      Format: NMWepKeyType (uint32)

      @@ -5036,7 +5227,7 @@ The actual string to print.

      wep-key0

      -

      Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted.

      +

      Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted.

      Format: string

      @@ -5044,7 +5235,7 @@ The actual string to print.

      wep-key1

      -

      Index 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.

      +

      Index 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.

      Format: string

      @@ -5052,7 +5243,7 @@ The actual string to print.

      wep-key2

      -

      Index 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.

      +

      Index 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.

      Format: string

      @@ -5060,7 +5251,7 @@ The actual string to print.

      wep-key3

      -

      Index 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.

      +

      Index 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.

      Format: string

      @@ -5068,7 +5259,7 @@ The actual string to print.

      wep-tx-keyidx

      -

      When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.

      +

      When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.

      Format: uint32

      @@ -5076,7 +5267,9 @@ The actual string to print.

      wps-method

      -

      Flags indicating which mode of WPS is to be used if any. There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities. WPS can be disabled by setting this property to a value of 1.

      +

      Flags indicating which mode of WPS is to be used if any.

      +

      There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities.

      +

      WPS can be disabled by setting this property to a value of 1.

      Format: uint32

      @@ -5087,7 +5280,7 @@ The actual string to print.

      wpan setting

      -

      IEEE 802.15.4 (WPAN) MAC Settings.

      +

      IEEE 802.15.4 (WPAN) MAC Settings.

      Properties:

      @@ -5102,7 +5295,7 @@ The actual string to print.

      Alias: channel

      -

      IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".

      +

      IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".

      Format: int32

      @@ -5112,7 +5305,7 @@ The actual string to print.

      Alias: mac

      -

      If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.

      +

      If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.

      Format: string

      @@ -5122,7 +5315,7 @@ The actual string to print.

      Alias: page

      -

      IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".

      +

      IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".

      Format: int32

      @@ -5132,7 +5325,7 @@ The actual string to print.

      Alias: pan-id

      -

      IEEE 802.15.4 Personal Area Network (PAN) identifier.

      +

      IEEE 802.15.4 Personal Area Network (PAN) identifier.

      Format: uint32

      @@ -5142,7 +5335,7 @@ The actual string to print.

      Alias: short-addr

      -

      Short IEEE 802.15.4 address to be used within a restricted environment.

      +

      Short IEEE 802.15.4 address to be used within a restricted environment.

      Format: uint32

      @@ -5153,7 +5346,7 @@ The actual string to print.

      bond-port setting

      -

      Bond Port Settings.

      +

      Bond Port Settings.

      Properties:

      @@ -5167,7 +5360,7 @@ The actual string to print.

      Alias: queue-id

      -

      The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.

      +

      The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.

      Format: uint32

      @@ -5177,7 +5370,7 @@ The actual string to print.

      hostname setting

      -

      Hostname settings.

      +

      Hostname settings.

      Properties:

      @@ -5190,7 +5383,8 @@ The actual string to print.

      from-dhcp

      -

      Whether the system hostname can be determined from DHCP on this connection. When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).

      +

      Whether the system hostname can be determined from DHCP on this connection.

      +

      When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).

      Format: NMTernary (int32)

      @@ -5198,7 +5392,8 @@ The actual string to print.

      from-dns-lookup

      -

      Whether the system hostname can be determined from reverse DNS lookup of addresses on this device. When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).

      +

      Whether the system hostname can be determined from reverse DNS lookup of addresses on this device.

      +

      When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).

      Format: NMTernary (int32)

      @@ -5206,7 +5401,9 @@ The actual string to print.

      only-from-default

      -

      If set to NM_TERNARY_TRUE (1), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6). If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn't have the default route. When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_FALSE (0).

      +

      If set to NM_TERNARY_TRUE (1), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6).

      +

      If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn't have the default route.

      +

      When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_FALSE (0).

      Format: NMTernary (int32)

      @@ -5214,7 +5411,9 @@ The actual string to print.

      priority

      -

      The relative priority of this connection to determine the system hostname. A lower numerical value is better (higher priority). A connection with higher priority is considered before connections with lower priority. If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100. Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname.

      +

      The relative priority of this connection to determine the system hostname. A lower numerical value is better (higher priority). A connection with higher priority is considered before connections with lower priority.

      +

      If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100.

      +

      Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname.

      Format: int32

      @@ -5225,7 +5424,7 @@ The actual string to print.

      veth setting

      -

      Veth Settings.

      +

      Veth Settings.

      Properties:

      @@ -5239,7 +5438,7 @@ The actual string to print.

      Alias: peer

      -

      This property specifies the peer interface name of the veth. This property is mandatory.

      +

      This property specifies the peer interface name of the veth. This property is mandatory.

      Format: string

      diff --git a/docs/api/html/nmcli-examples.html b/docs/api/html/nmcli-examples.html index 2bc6cbc2..0a832ab7 100644 --- a/docs/api/html/nmcli-examples.html +++ b/docs/api/html/nmcli-examples.html @@ -633,6 +633,62 @@ Connection 'ethernet-4' (de89cdeb-a3e1-4d53-8fa0-c22546c775f4) successfully 
      $ nmcli connection add type bluetooth con-name "My Bluetooth Hotspot" autoconnect no ifname btnap0 bluetooth.type nap ipv4.method shared ipv6.method shared
      +
      +

      Example 18. Offline use

      +
      +
      $ nmcli --offline con add type ethernet '
+  conn.id eth0 \
+  conn.interface-name eth0 \
+  >/sysroot/etc/NetworkManager/system-connections/eth0.nmconnection
      +

      + Creates a connection file in keyfile format without using the NetworkManager service. + This allows for use of familiar nmcli 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. +

      +
      $ nmcli --offline con modify type ethernet '
+  conn.id eth0-ipv6 \
+  ipv4.method disabled \
+  </sysroot/etc/NetworkManager/system-connections/eth0.nmconnection \
+  >/sysroot/etc/NetworkManager/system-connections/eth0-ipv6.nmconnection
      +

      + Read and write a connection file without using the NetworkManager service, modifying + some properties along the way. +

      +

      + This allows templating of the connection profiles using familiar + nmcli syntax in situations where the service is not running. +

      +
      +
      +
      +

      Example 19. Device Checkpoint and Restore

      +
      +
      $ nmcli dev checkpoint eth0 -- nmcli dev dis eth0
+Device 'eth0' successfully disconnected.
+Type "Yes" to commit the changes: No
+Checkpoint was removed.
      +

      + In this example the device eth0 was disconnected with the eth0 checkpoint + taken. The user didn't confirm that the change is good, so the eth0 was + brought back to the state it was when the checkpoint was taken. +

      +

      + If the command being run unintentionaly brings down the remote connection + (such as a + ssh(1) + session) to the very machine it's being run on, the user wouldn't be able to + confirm the success and the connectivity would end up being restored + after a timeout. +

      +

      + 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: +

      +
      $ nmcli dev checkpoint -- ip link del br0
+Type "Yes" to commit the changes: Yes
      +
      +

      diff --git a/docs/api/html/nmcli.html b/docs/api/html/nmcli.html index 5ca8f1f4..526f1ee6 100644 --- a/docs/api/html/nmcli.html +++ b/docs/api/html/nmcli.html @@ -184,6 +184,18 @@ processing.

      +

      --offline

      + +

      Work without a daemon. Makes connection add and + connection modify commands accept and produce connection + data via standard input/output. Ordinarily, nmcli would communicate with + the NetworkManager service.

      +

      The connection data format (keyfile) is described in + nm-settings-keyfile(5) + manual.

      + + +

      -v | --version

      Show nmcli version.

      @@ -657,7 +669,7 @@ modify [--temporary] [ id | uuid | path ] - ID + [ID] { option value | [+|-]setting.property value } ... @@ -682,7 +694,13 @@ 802-1x.phase1-auth-flags etc.

      The connection is identified by its name, UUID or D-Bus path. If ID is ambiguous, a keyword id, - uuid or path can be used.

      + uuid or path can be used. + The ID is not used with the global + --offline option.

      +

      When the global --offline is used, the + command reads the connection from the standard input and prints the + modified connection to standard output instead of making the + the NetworkManager daemon act upon specified connection.

      @@ -770,6 +788,9 @@
      +

      When the global --offline is used, the + command prints the resulting connection to standard output instead of + actually adding the connection via the NetworkManager daemon.

      @@ -964,7 +985,7 @@

      Device Management Commands

      -

      nmcli device { status | show | set | up | connect | reapply | modify | down | disconnect | delete | monitor | wifi | lldp } [ARGUMENTS...]

      +

      nmcli device { status | show | set | up | connect | reapply | modify | down | disconnect | delete | monitor | wifi | lldp | checkpoint } [ARGUMENTS...]

      Show and manage network interfaces.

      @@ -1305,6 +1326,28 @@ used to list neighbors only for a given interface. The protocol must be enabled in the connection settings.

      + + + +

      + checkpoint + [--timeout seconds] + [ifname...] + -- + COMMAND... +

      		+

      Runs the command with a configuration checkpoint taken and asks for a + confirmation when finished. When the confirmation is not given, the + checkpoint is automatically restored after timeout.

      +

      This allows doing disruptive configuration changes over remote + connections with an option of restoring the network configuration to a + known good state in case of an error.

      +

      If the a list of interface names is specified, the checkpoint is + taken, the checkpoint is takes only on the specified devices. Otherwise + a checkpoint is taken for all devices.

      +

      Currently the timeout defaults to 15 seconds. This may change in + a future version.

      +
      diff --git a/docs/api/html/ref-settings.html b/docs/api/html/ref-settings.html index 5e7e464d..f35354f9 100644 --- a/docs/api/html/ref-settings.html +++ b/docs/api/html/ref-settings.html @@ -28,160 +28,160 @@
      Configuration Settings
      -connection — General Connection Profile Settings +connection — General Connection Profile Settings
      -6lowpan — 6LoWPAN Settings +6lowpan — 6LoWPAN Settings
      -802-1x — IEEE 802.1x Authentication Settings +802-1x — IEEE 802.1x Authentication Settings
      -adsl — ADSL Settings +adsl — ADSL Settings
      -bluetooth — Bluetooth Settings +bluetooth — Bluetooth Settings
      -bond — Bonding Settings +bond — Bonding Settings
      -bridge — Bridging Settings +bridge — Bridging Settings
      -bridge-port — Bridge Port Settings +bridge-port — Bridge Port Settings
      -cdma — CDMA-based Mobile Broadband Settings +cdma — CDMA-based Mobile Broadband Settings
      -dcb — Data Center Bridging Settings +dcb — Data Center Bridging Settings
      -dummy — Dummy Link Settings +dummy — Dummy Link Settings
      -ethtool — Ethtool Ethernet Settings +ethtool — Ethtool Ethernet Settings
      -generic — Generic Link Settings +generic — Generic Link Settings
      -gsm — GSM-based Mobile Broadband Settings +gsm — GSM-based Mobile Broadband Settings
      -infiniband — Infiniband Settings +infiniband — Infiniband Settings
      -ipv4 — IPv4 Settings +ipv4 — IPv4 Settings
      -ipv6 — IPv6 Settings +ipv6 — IPv6 Settings
      -ip-tunnel — IP Tunneling Settings +ip-tunnel — IP Tunneling Settings
      -macsec — MACSec Settings +macsec — MACSec Settings
      -macvlan — MAC VLAN Settings +macvlan — MAC VLAN Settings
      -match — Match settings +match — Match settings
      -802-11-olpc-mesh — OLPC Wireless Mesh Settings +802-11-olpc-mesh — OLPC Wireless Mesh Settings
      -ovs-bridge — OvsBridge Link Settings +ovs-bridge — OvsBridge Link Settings
      -ovs-dpdk — OvsDpdk Link Settings +ovs-dpdk — OvsDpdk Link Settings
      -ovs-interface — Open vSwitch Interface Settings +ovs-interface — Open vSwitch Interface Settings
      -ovs-patch — OvsPatch Link Settings +ovs-patch — OvsPatch Link Settings
      -ovs-port — OvsPort Link Settings +ovs-port — OvsPort Link Settings
      -ppp — Point-to-Point Protocol Settings +ppp — Point-to-Point Protocol Settings
      -pppoe — PPP-over-Ethernet Settings +pppoe — PPP-over-Ethernet Settings
      -proxy — WWW Proxy Settings +proxy — WWW Proxy Settings
      -serial — Serial Link Settings +serial — Serial Link Settings
      -sriov — SR-IOV settings +sriov — SR-IOV settings
      -tc — Linux Traffic Control Settings +tc — Linux Traffic Control Settings
      -team — Teaming Settings +team — Teaming Settings
      -team-port — Team Port Settings +team-port — Team Port Settings
      -tun — Tunnel Settings +tun — Tunnel Settings
      -user — General User Profile Settings +user — General User Profile Settings
      -vlan — VLAN Settings +vlan — VLAN Settings
      -vpn — VPN Settings +vpn — VPN Settings
      -vrf — VRF settings +vrf — VRF settings
      -vxlan — VXLAN Settings +vxlan — VXLAN Settings
      -wifi-p2p — Wi-Fi P2P Settings +wifi-p2p — Wi-Fi P2P Settings
      -wimax — WiMax Settings +wimax — WiMax Settings
      -802-3-ethernet — Wired Ethernet Settings +802-3-ethernet — Wired Ethernet Settings
      -wireguard — WireGuard Settings +wireguard — WireGuard Settings
      -802-11-wireless — Wi-Fi Settings +802-11-wireless — Wi-Fi Settings
      -802-11-wireless-security — Wi-Fi Security Settings +802-11-wireless-security — Wi-Fi Security Settings
      -wpan — IEEE 802.15.4 (WPAN) MAC Settings +wpan — IEEE 802.15.4 (WPAN) MAC Settings
      -bond-port — Bond Port Settings +bond-port — Bond Port Settings
      -hostname — Hostname settings +hostname — Hostname settings
      -ovs-external-ids — OVS External IDs Settings +ovs-external-ids — OVS External IDs Settings
      -veth — Veth Settings +veth — Veth Settings
      Secret flag types
      diff --git a/docs/api/html/settings-6lowpan.html b/docs/api/html/settings-6lowpan.html index fd163b30..a185cc5f 100644 --- a/docs/api/html/settings-6lowpan.html +++ b/docs/api/html/settings-6lowpan.html @@ -29,7 +29,7 @@

      6lowpan

      -

      6lowpan — 6LoWPAN Settings

      +

      6lowpan — 6LoWPAN Settings
      @@ -56,7 +56,7 @@ 
      parent
      string
      
-If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.
+ 
 
 
      
 
      
diff --git a/docs/api/html/settings-802-11-olpc-mesh.html b/docs/api/html/settings-802-11-olpc-mesh.html
index b5370389..86a6c492 100644
--- a/docs/api/html/settings-802-11-olpc-mesh.html
+++ b/docs/api/html/settings-802-11-olpc-mesh.html
@@ -29,7 +29,7 @@
 
      
 
 
      802-11-olpc-mesh
      
-
      802-11-olpc-mesh — OLPC Wireless Mesh Settings
      
+
      802-11-olpc-mesh —  OLPC Wireless Mesh Settings
      
       		
 
 
      
@@ -57,19 +57,19 @@
 
      channel
      
 
      uint32
      
 
      0
      
-Channel on which the mesh network to join is located.
+ 
 
 
 
      dhcp-anycast-address
      
 
      byte array
      
 
      
-Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request. This is currently only implemented by dhclient DHCP plugin.
+ 
 
 
 
      ssid
      
 
      byte array
      
 
      
-SSID of the mesh network to join.
+ 
 
 
 
      
diff --git a/docs/api/html/settings-802-11-wireless-security.html b/docs/api/html/settings-802-11-wireless-security.html
index d2926389..7f6d2474 100644
--- a/docs/api/html/settings-802-11-wireless-security.html
+++ b/docs/api/html/settings-802-11-wireless-security.html
@@ -29,7 +29,7 @@
 
      
 
 
      802-11-wireless-security
      
-
      802-11-wireless-security — Wi-Fi Security Settings
      
+
      802-11-wireless-security —  Wi-Fi Security Settings
      
       		
 
 
      
@@ -57,121 +57,121 @@
 
      auth-alg
      
 
      string
      
 
      
-When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here.  One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP.  When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.
+ 
 
 
 
      fils
      
 
      int32
      
 
      0
      
-Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection.  One of NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (1) (disable FILS), NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (2) (enable FILS if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (3) (enable FILS and fail if not supported).  When set to NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) and no global default is set, FILS will be optionally enabled.
+ 
 
 
 
      group
      
 
      array of string
      
 
      
-A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list.  For maximum compatibility leave this property empty.  Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".
+ 
 
 
 
      key-mgmt
      
 
      string
      
 
      
-Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only). This property must be set for any Wi-Fi connection that uses security.
+ 
 
 
 
      leap-password
      
 
      string
      
 
      
-The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").
+ 
 
 
 
      leap-password-flags
      
 
      NMSettingSecretFlags (uint32)
      
 
      
-Flags indicating how to handle the "leap-password" property.
+ 
 
 
 
      leap-username
      
 
      string
      
 
      
-The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").
+ 
 
 
 
      pairwise
      
 
      array of string
      
 
      
-A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty.  Each list element may be one of "tkip" or "ccmp".
+ 
 
 
 
      pmf
      
 
      int32
      
 
      0
      
-Indicates whether Protected Management Frames (802.11w) must be enabled for the connection.  One of NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE (1) (disable PMF), NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL (2) (enable PMF if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED (3) (enable PMF and fail if not supported).  When set to NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) and no global default is set, PMF will be optionally enabled.
+ 
 
 
 
      proto
      
 
      array of string
      
 
      
-List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN).  If not specified, both WPA and RSN connections are allowed.
+ 
 
 
 
      psk
      
 
      string
      
 
      
-Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication.
+ 
 
 
 
      psk-flags
      
 
      NMSettingSecretFlags (uint32)
      
 
      
-Flags indicating how to handle the "psk" property.
+ 
 
 
 
      wep-key-flags
      
 
      NMSettingSecretFlags (uint32)
      
 
      
-Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.
+ 
 
 
 
      wep-key-type
      
 
      NMWepKeyType (uint32)
      
 
      
-Controls the interpretation of WEP keys.  Allowed values are NM_WEP_KEY_TYPE_KEY (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or NM_WEP_KEY_TYPE_PASSPHRASE (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.
+ 
 
 
 
      wep-key0
      
 
      string
      
 
      
-Index 0 WEP key.  This is the WEP key used in most networks.  See the "wep-key-type" property for a description of how this key is interpreted.
+ 
 
 
 
      wep-key1
      
 
      string
      
 
      
-Index 1 WEP key.  This WEP index is not used by most networks.  See the "wep-key-type" property for a description of how this key is interpreted.
+ 
 
 
 
      wep-key2
      
 
      string
      
 
      
-Index 2 WEP key.  This WEP index is not used by most networks.  See the "wep-key-type" property for a description of how this key is interpreted.
+ 
 
 
 
      wep-key3
      
 
      string
      
 
      
-Index 3 WEP key.  This WEP index is not used by most networks.  See the "wep-key-type" property for a description of how this key is interpreted.
+ 
 
 
 
      wep-tx-keyidx
      
 
      uint32
      
 
      0
      
-When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here.  Valid values are 0 (default key) through 3.  Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.
+ 
 
 
 
      wps-method
      
 
      uint32
      
 
      0
      
-Flags indicating which mode of WPS is to be used if any. There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities. WPS can be disabled by setting this property to a value of 1.
+ 
 
 
 
      
diff --git a/docs/api/html/settings-802-11-wireless.html b/docs/api/html/settings-802-11-wireless.html
index 68d7e07c..00372730 100644
--- a/docs/api/html/settings-802-11-wireless.html
+++ b/docs/api/html/settings-802-11-wireless.html
@@ -29,7 +29,7 @@
 
      
 
 
      802-11-wireless
      
-
      802-11-wireless — Wi-Fi Settings
      
+
      802-11-wireless —  Wi-Fi Settings
      
       		
 
 
      
@@ -57,121 +57,121 @@
 
      ap-isolation
      
 
      NMTernary (int32)
      
 
      
-Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from NM_TERNARY_DEFAULT (-1) only when the interface is configured in AP mode. If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc. If set to NM_TERNARY_FALSE (0), devices can talk to each other. When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_FALSE (0).
+ 
 
 
 
      assigned-mac-address
      
 
      string
      
 
      
-The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explicit hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".
+ 
 
 
 
      band
      
 
      string
      
 
      
-802.11 frequency band of the network.  One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11.  This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible.  This setting depends on specific driver capability and may not work with all drivers.
+ 
 
 
 
      bssid
      
 
      byte array
      
 
      
-If specified, directs the device to only associate with the given access point.  This capability is highly driver dependent and not supported by all devices.  Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.
+ 
 
 
 
      channel
      
 
      uint32
      
 
      0
      
-Wireless channel to use for the Wi-Fi connection.  The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel.  Because channel numbers overlap between bands, this property also requires the "band" property to be set.
+ 
 
 
 
      cloned-mac-address
      
 
      byte array
      
 
      
-This D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". For libnm and nmcli, this field is called "cloned-mac-address".
+ 
 
 
 
      generate-mac-address-mask
      
 
      string
      
 
      
-With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.
+ 
 
 
 
      hidden
      
 
      boolean
      
 
      FALSE
      
-If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode. In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID.  However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution. In AP mode, the created network does not broadcast its SSID. Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.
+ 
 
 
 
      mac-address
      
 
      byte array
      
 
      
-If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).
+ 
 
 
 
      mac-address-blacklist
      
 
      array of string
      
 
      
-A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply.  Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").
+ 
 
 
 
      mac-address-randomization
      
 
      uint32
      
 
      0
      
-One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization),  NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address). This property is deprecated for 'cloned-mac-address'. Deprecated: 1
+ 
 
 
 
      mode
      
 
      string
      
 
      
-Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap".  If blank, infrastructure is assumed.
+ 
 
 
 
      mtu
      
 
      uint32
      
 
      0
      
-If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.
+ 
 
 
 
      powersave
      
 
      uint32
      
 
      0
      
-One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.
+ 
 
 
 
      rate
      
 
      uint32
      
 
      0
      
-If non-zero, directs the device to only use the specified bitrate for communication with the access point.  Units are in Kb/s, ie 5500 = 5.5 Mbit/s.  This property is highly driver dependent and not all devices support setting a static bitrate.
+ 
 
 
 
      security
      
 
      
 
      
-This property is deprecated, but can be set to the value '802-11-wireless-security' when a wireless security setting is also present in the connection dictionary, for compatibility with very old NetworkManager daemons.
+ 
 
 
 
      seen-bssids
      
 
      array of string
      
 
      
-A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network.  NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.
+ 
 
 
 
      ssid
      
 
      byte array
      
 
      
-SSID of the Wi-Fi network. Must be specified.
+ 
 
 
 
      tx-power
      
 
      uint32
      
 
      0
      
-If non-zero, directs the device to use the specified transmit power. Units are dBm.  This property is highly driver dependent and not all devices support setting a static transmit power.
+ 
 
 
 
      wake-on-wlan
      
 
      uint32
      
 
      1
      
-The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).
+ 
 
 
 
      
diff --git a/docs/api/html/settings-802-1x.html b/docs/api/html/settings-802-1x.html
index 91015533..97827e6a 100644
--- a/docs/api/html/settings-802-1x.html
+++ b/docs/api/html/settings-802-1x.html
@@ -29,7 +29,7 @@
 
      
 
 
      802-1x
      
-
      802-1x — IEEE 802.1x Authentication Settings
      
+
      802-1x —  IEEE 802.1x Authentication Settings
      
       		
 
 
      
@@ -57,283 +57,283 @@
 
      altsubject-matches
      
 
      array of string
      
 
      
-List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.
+ 
 
 
 
      anonymous-identity
      
 
      string
      
 
      
-Anonymous identity string for EAP authentication methods.  Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.
+ 
 
 
 
      auth-timeout
      
 
      int32
      
 
      0
      
-A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.
+ 
 
 
 
      ca-cert
      
 
      byte array
      
 
      
-Contains the CA certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.
+ 
 
 
 
      ca-cert-password
      
 
      string
      
 
      
-The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
+ 
 
 
 
      ca-cert-password-flags
      
 
      NMSettingSecretFlags (uint32)
      
 
      
-Flags indicating how to handle the "ca-cert-password" property.
+ 
 
 
 
      ca-path
      
 
      string
      
 
      
-UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property. If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.
+ 
 
 
 
      client-cert
      
 
      byte array
      
 
      
-Contains the client certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte.
+ 
 
 
 
      client-cert-password
      
 
      string
      
 
      
-The password used to access the client certificate stored in "client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
+ 
 
 
 
      client-cert-password-flags
      
 
      NMSettingSecretFlags (uint32)
      
 
      
-Flags indicating how to handle the "client-cert-password" property.
+ 
 
 
 
      domain-match
      
 
      string
      
 
      
-Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server.  If a matching dNSName is found, this constraint is met.  If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.
+ 
 
 
 
      domain-suffix-match
      
 
      string
      
 
      
-Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server.  If a matching dNSName is found, this constraint is met.  If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.
+ 
 
 
 
      eap
      
 
      array of string
      
 
      
-The allowed EAP method to be used when authenticating to the network with 802.1x.  Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast".  Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.
+ 
 
 
 
      identity
      
 
      string
      
 
      
-Identity string for EAP authentication methods.  Often the user's user or login name.
+ 
 
 
 
      optional
      
 
      boolean
      
 
      FALSE
      
-Whether the 802.1X authentication is optional. If TRUE, the activation will continue even after a timeout or an authentication failure. Setting the property to TRUE is currently allowed only for Ethernet connections. If set to FALSE, the activation can continue only after a successful authentication.
+ 
 
 
 
      pac-file
      
 
      string
      
 
      
-UTF-8 encoded file path containing PAC for EAP-FAST.
+ 
 
 
 
      password
      
 
      string
      
 
      
-UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.
+ 
 
 
 
      password-flags
      
 
      NMSettingSecretFlags (uint32)
      
 
      
-Flags indicating how to handle the "password" property.
+ 
 
 
 
      password-raw
      
 
      byte array
      
 
      
-Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.
+ 
 
 
 
      password-raw-flags
      
 
      NMSettingSecretFlags (uint32)
      
 
      
-Flags indicating how to handle the "password-raw" property.
+ 
 
 
 
      phase1-auth-flags
      
 
      uint32
      
 
      0
      
-Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x settings. See the wpa_supplicant documentation for more details.
+ 
 
 
 
      phase1-fast-provisioning
      
 
      string
      
 
      
-Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning).  See the wpa_supplicant documentation for more details.
+ 
 
 
 
      phase1-peaplabel
      
 
      string
      
 
      
-Forces use of the new PEAP label during key derivation.  Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1.  Set to "1" to force use of the new PEAP label.  See the wpa_supplicant documentation for more details.
+ 
 
 
 
      phase1-peapver
      
 
      string
      
 
      
-Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property.  When unset, the version reported by the server will be used.  Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version.  To do so, this property may be set to "0" or "1" to force that specific PEAP version.
+ 
 
 
 
      phase2-altsubject-matches
      
 
      array of string
      
 
      
-List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.
+ 
 
 
 
      phase2-auth
      
 
      string
      
 
      
-Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property.  For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method.  For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.
+ 
 
 
 
      phase2-autheap
      
 
      string
      
 
      
-Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property.  Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.
+ 
 
 
 
      phase2-ca-cert
      
 
      byte array
      
 
      
-Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.
+ 
 
 
 
      phase2-ca-cert-password
      
 
      string
      
 
      
-The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
+ 
 
 
 
      phase2-ca-cert-password-flags
      
 
      NMSettingSecretFlags (uint32)
      
 
      
-Flags indicating how to handle the "phase2-ca-cert-password" property.
+ 
 
 
 
      phase2-ca-path
      
 
      string
      
 
      
-UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property. If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.
+ 
 
 
 
      phase2-client-cert
      
 
      byte array
      
 
      
-Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.
+ 
 
 
 
      phase2-client-cert-password
      
 
      string
      
 
      
-The password used to access the "phase2" client certificate stored in "phase2-client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
+ 
 
 
 
      phase2-client-cert-password-flags
      
 
      NMSettingSecretFlags (uint32)
      
 
      
-Flags indicating how to handle the "phase2-client-cert-password" property.
+ 
 
 
 
      phase2-domain-match
      
 
      string
      
 
      
-Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met.  If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.
+ 
 
 
 
      phase2-domain-suffix-match
      
 
      string
      
 
      
-Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication.  If a matching dNSName is found, this constraint is met.  If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.
+ 
 
 
 
      phase2-private-key
      
 
      byte array
      
 
      
-Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.
+ 
 
 
 
      phase2-private-key-password
      
 
      string
      
 
      
-The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS#12 format key.
+ 
 
 
 
      phase2-private-key-password-flags
      
 
      NMSettingSecretFlags (uint32)
      
 
      
-Flags indicating how to handle the "phase2-private-key-password" property.
+ 
 
 
 
      phase2-subject-match
      
 
      string
      
 
      
-Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed.  This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2-domain-suffix-match.
+ 
 
 
 
      pin
      
 
      string
      
 
      
-PIN used for EAP authentication methods.
+ 
 
 
 
      pin-flags
      
 
      NMSettingSecretFlags (uint32)
      
 
      
-Flags indicating how to handle the "pin" property.
+ 
 
 
 
      private-key
      
 
      byte array
      
 
      
-Contains the private key when the "eap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users.  Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.
+ 
 
 
 
      private-key-password
      
 
      string
      
 
      
-The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.
+ 
 
 
 
      private-key-password-flags
      
 
      NMSettingSecretFlags (uint32)
      
 
      
-Flags indicating how to handle the "private-key-password" property.
+ 
 
 
 
      subject-match
      
 
      string
      
 
      
-Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed.  This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain-suffix-match.
+ 
 
 
 
      system-ca-certs
      
 
      boolean
      
 
      FALSE
      
-When TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch.  The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).
+ 
 
 
 
      
diff --git a/docs/api/html/settings-802-3-ethernet.html b/docs/api/html/settings-802-3-ethernet.html
index b743783e..b3132cf3 100644
--- a/docs/api/html/settings-802-3-ethernet.html
+++ b/docs/api/html/settings-802-3-ethernet.html
@@ -29,7 +29,7 @@
 
      
 
 
      802-3-ethernet
      
-
      802-3-ethernet — Wired Ethernet Settings
      
+
      802-3-ethernet —  Wired Ethernet Settings
      
       		
 
 
      
@@ -57,97 +57,97 @@
 
      accept-all-mac-addresses
      
 
      NMTernary (int32)
      
 
      
-When TRUE, setup the interface to accept packets for all MAC addresses. This is enabling the kernel interface flag IFF_PROMISC. When FALSE, the interface will only accept the packets with the interface destination mac address or broadcast.
+ 
 
 
 
      assigned-mac-address
      
 
      string
      
 
      
-The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explicit hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".
+ 
 
 
 
      auto-negotiate
      
 
      boolean
      
 
      FALSE
      
-When TRUE, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped.
+ 
 
 
 
      cloned-mac-address
      
 
      byte array
      
 
      
-This D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". For libnm and nmcli, this field is called "cloned-mac-address".
+ 
 
 
 
      duplex
      
 
      string
      
 
      
-When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.
+ 
 
 
 
      generate-mac-address-mask
      
 
      string
      
 
      
-With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.
+ 
 
 
 
      mac-address
      
 
      byte array
      
 
      
-If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).
+ 
 
 
 
      mac-address-blacklist
      
 
      array of string
      
 
      
-If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list.  Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).
+ 
 
 
 
      mtu
      
 
      uint32
      
 
      0
      
-If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.
+ 
 
 
 
      port
      
 
      string
      
 
      
-Specific port type to use if the device supports multiple attachment methods.  One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored.
+ 
 
 
 
      s390-nettype
      
 
      string
      
 
      
-s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.
+ 
 
 
 
      s390-options
      
 
      dict of string to string
      
 
      {}
      
-Dictionary of key/value pairs of s390-specific device options.  Both keys and values must be strings.  Allowed keys include "portno", "layer2", "portname", "protocol", among others.  Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]). Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.
+ 
 
 
 
      s390-subchannels
      
 
      array of string
      
 
      
-Identifies specific subchannels that this network device uses for communication with z/VM or s390 host.  Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels.  The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.
+ 
 
 
 
      speed
      
 
      uint32
      
 
      0
      
-When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.
+ 
 
 
 
      wake-on-lan
      
 
      uint32
      
 
      1
      
-The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).
+ 
 
 
 
      wake-on-lan-password
      
 
      string
      
 
      
-If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address.  If NULL, no password will be required.
+ 
 
 
 
      
diff --git a/docs/api/html/settings-adsl.html b/docs/api/html/settings-adsl.html
index 10cdb8d2..9c9cd333 100644
--- a/docs/api/html/settings-adsl.html
+++ b/docs/api/html/settings-adsl.html
@@ -29,7 +29,7 @@
 
      
 
 
      adsl
      
-
      adsl — ADSL Settings
      
+
      adsl —  ADSL Settings
      
       		
 
 
      
@@ -57,43 +57,43 @@
 
      encapsulation
      
 
      string
      
 
      
-Encapsulation of ADSL connection.  Can be "vcmux" or "llc".
+ 
 
 
 
      password
      
 
      string
      
 
      
-Password used to authenticate with the ADSL service.
+ 
 
 
 
      password-flags
      
 
      NMSettingSecretFlags (uint32)
      
 
      
-Flags indicating how to handle the "password" property.
+ 
 
 
 
      protocol
      
 
      string
      
 
      
-ADSL connection protocol.  Can be "pppoa", "pppoe" or "ipoatm".
+ 
 
 
 
      username
      
 
      string
      
 
      
-Username used to authenticate with the ADSL service.
+ 
 
 
 
      vci
      
 
      uint32
      
 
      0
      
-VCI of ADSL connection
+ 
 
 
 
      vpi
      
 
      uint32
      
 
      0
      
-VPI of ADSL connection
+ 
 
 
 
      
diff --git a/docs/api/html/settings-bluetooth.html b/docs/api/html/settings-bluetooth.html
index 91bdf443..6af4a0ee 100644
--- a/docs/api/html/settings-bluetooth.html
+++ b/docs/api/html/settings-bluetooth.html
@@ -29,7 +29,7 @@
 
      
 
 
      bluetooth
      
-
      bluetooth — Bluetooth Settings
      
+
      bluetooth —  Bluetooth Settings
      
       		
 
 
      
@@ -57,13 +57,13 @@
 
      bdaddr
      
 
      byte array
      
 
      
-The Bluetooth address of the device.
+ 
 
 
 
      type
      
 
      string
      
 
      
-Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.
+ 
 
 
 
      
diff --git a/docs/api/html/settings-bond-port.html b/docs/api/html/settings-bond-port.html
index 6496b891..dc63034a 100644
--- a/docs/api/html/settings-bond-port.html
+++ b/docs/api/html/settings-bond-port.html
@@ -29,7 +29,7 @@
 
      
 
 
      bond-port
      
-
      bond-port — Bond Port Settings
      
+
      bond-port —  Bond Port Settings
      
       		
 
 
      
@@ -56,7 +56,7 @@
 
      queue-id
      
 
      uint32
      
 
      0
      
-The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.
+ 
 
 
      
 
      
diff --git a/docs/api/html/settings-bond.html b/docs/api/html/settings-bond.html
index 30fc8781..81b21536 100644
--- a/docs/api/html/settings-bond.html
+++ b/docs/api/html/settings-bond.html
@@ -29,7 +29,7 @@
 
      
 
 
      bond
      
-
      bond — Bonding Settings
      
+
      bond —  Bonding Settings
      
       		
 
 
      
@@ -57,13 +57,13 @@
 
      interface-name
      
 
      string
      
 
      
-Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bond's interface name.
+ 
 
 
 
      options
      
 
      dict of string to string
      
 
      {'mode': 'balance-rr'}
      
-Dictionary of key/value pairs of bonding options.  Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).
+ 
 
 
 
      
diff --git a/docs/api/html/settings-bridge-port.html b/docs/api/html/settings-bridge-port.html
index 7b72a526..7ab80feb 100644
--- a/docs/api/html/settings-bridge-port.html
+++ b/docs/api/html/settings-bridge-port.html
@@ -29,7 +29,7 @@
 
      
 
 
      bridge-port
      
-
      bridge-port — Bridge Port Settings
      
+
      bridge-port —  Bridge Port Settings
      
       		
 
 
      
@@ -57,25 +57,25 @@
 
      hairpin-mode
      
 
      boolean
      
 
      FALSE
      
-Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.
+ 
 
 
 
      path-cost
      
 
      uint32
      
 
      100
      
-The Spanning Tree Protocol (STP) port cost for destinations via this port.
+ 
 
 
 
      priority
      
 
      uint32
      
 
      32
      
-The Spanning Tree Protocol (STP) priority of this bridge port.
+ 
 
 
 
      vlans
      
 
      array of vardict
      
 
      
-Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property. In nmcli the VLAN list can be specified with the following syntax: $vid [pvid] [untagged] [, $vid [pvid] [untagged]]... where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.
+ 
 
 
 
      
diff --git a/docs/api/html/settings-bridge.html b/docs/api/html/settings-bridge.html
index 244f728a..b47077e9 100644
--- a/docs/api/html/settings-bridge.html
+++ b/docs/api/html/settings-bridge.html
@@ -29,7 +29,7 @@
 
      
 
 
      bridge
      
-
      bridge — Bridging Settings
      
+
      bridge —  Bridging Settings
      
       		
 
 
      
@@ -57,169 +57,169 @@
 
      ageing-time
      
 
      uint32
      
 
      300
      
-The Ethernet MAC address aging time, in seconds.
+ 
 
 
 
      forward-delay
      
 
      uint32
      
 
      15
      
-The Spanning Tree Protocol (STP) forwarding delay, in seconds.
+ 
 
 
 
      group-address
      
 
      byte array
      
 
      
-If specified, The MAC address of the multicast group this bridge uses for STP. The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00.
+ 
 
 
 
      group-forward-mask
      
 
      uint32
      
 
      0
      
-A mask of group addresses to forward. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can't have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP.
+ 
 
 
 
      hello-time
      
 
      uint32
      
 
      2
      
-The Spanning Tree Protocol (STP) hello time, in seconds.
+ 
 
 
 
      interface-name
      
 
      string
      
 
      
-Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bridge's interface name.
+ 
 
 
 
      mac-address
      
 
      byte array
      
 
      
-If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge. Hence, this property is deprecated. Deprecated: 1
+ 
 
 
 
      max-age
      
 
      uint32
      
 
      20
      
-The Spanning Tree Protocol (STP) maximum message age, in seconds.
+ 
 
 
 
      multicast-hash-max
      
 
      uint32
      
 
      4096
      
-Set maximum size of multicast hash table (value must be a power of 2).
+ 
 
 
 
      multicast-last-member-count
      
 
      uint32
      
 
      2
      
-Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.
+ 
 
 
 
      multicast-last-member-interval
      
 
      uint64
      
 
      100
      
-Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.
+ 
 
 
 
      multicast-membership-interval
      
 
      uint64
      
 
      26000
      
-Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.
+ 
 
 
 
      multicast-querier
      
 
      boolean
      
 
      FALSE
      
-Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.
+ 
 
 
 
      multicast-querier-interval
      
 
      uint64
      
 
      25500
      
-If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.
+ 
 
 
 
      multicast-query-interval
      
 
      uint64
      
 
      12500
      
-Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.
+ 
 
 
 
      multicast-query-response-interval
      
 
      uint64
      
 
      1000
      
-Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.
+ 
 
 
 
      multicast-query-use-ifaddr
      
 
      boolean
      
 
      FALSE
      
-If enabled the bridge's own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used.
+ 
 
 
 
      multicast-router
      
 
      string
      
 
      
-Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work. Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).
+ 
 
 
 
      multicast-snooping
      
 
      boolean
      
 
      TRUE
      
-Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.
+ 
 
 
 
      multicast-startup-query-count
      
 
      uint32
      
 
      2
      
-Set the number of IGMP queries to send during startup phase.
+ 
 
 
 
      multicast-startup-query-interval
      
 
      uint64
      
 
      3125
      
-Sets the time (in deciseconds) between queries sent out at startup to determine membership information.
+ 
 
 
 
      priority
      
 
      uint32
      
 
      32768
      
-Sets the Spanning Tree Protocol (STP) priority for this bridge.  Lower values are "better"; the lowest priority bridge will be elected the root bridge.
+ 
 
 
 
      stp
      
 
      boolean
      
 
      TRUE
      
-Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.
+ 
 
 
 
      vlan-default-pvid
      
 
      uint32
      
 
      1
      
-The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.
+ 
 
 
 
      vlan-filtering
      
 
      boolean
      
 
      FALSE
      
-Control whether VLAN filtering is enabled on the bridge.
+ 
 
 
 
      vlan-protocol
      
 
      string
      
 
      
-If specified, the protocol used for VLAN filtering. Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.
+ 
 
 
 
      vlan-stats-enabled
      
 
      boolean
      
 
      FALSE
      
-Controls whether per-VLAN stats accounting is enabled.
+ 
 
 
 
      vlans
      
 
      array of vardict
      
 
      
-Array of bridge VLAN objects. In addition to the VLANs specified here, the bridge will also have the default-pvid VLAN configured  by the bridge.vlan-default-pvid property. In nmcli the VLAN list can be specified with the following syntax: $vid [pvid] [untagged] [, $vid [pvid] [untagged]]... where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.
+ 
 
 
 
      
diff --git a/docs/api/html/settings-cdma.html b/docs/api/html/settings-cdma.html
index 054dee32..c718232d 100644
--- a/docs/api/html/settings-cdma.html
+++ b/docs/api/html/settings-cdma.html
@@ -29,7 +29,7 @@
 
      
 
 
      cdma
      
-
      cdma — CDMA-based Mobile Broadband Settings
      
+
      cdma —  CDMA-based Mobile Broadband Settings
      
       		
 
 
      
@@ -57,31 +57,31 @@
 
      mtu
      
 
      uint32
      
 
      0
      
-If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.
+ 
 
 
 
      number
      
 
      string
      
 
      
-The number to dial to establish the connection to the CDMA-based mobile broadband network, if any.  If not specified, the default number (#777) is used when required.
+ 
 
 
 
      password
      
 
      string
      
 
      
-The password used to authenticate with the network, if required.  Many providers do not require a password, or accept any password.  But if a password is required, it is specified here.
+ 
 
 
 
      password-flags
      
 
      NMSettingSecretFlags (uint32)
      
 
      
-Flags indicating how to handle the "password" property.
+ 
 
 
 
      username
      
 
      string
      
 
      
-The username used to authenticate with the network, if required.  Many providers do not require a username, or accept any username.  But if a username is required, it is specified here.
+ 
 
 
 
      
diff --git a/docs/api/html/settings-connection.html b/docs/api/html/settings-connection.html
index f8e3c6c3..fd66ad01 100644
--- a/docs/api/html/settings-connection.html
+++ b/docs/api/html/settings-connection.html
@@ -29,7 +29,7 @@
 
      
 
 
      connection
      
-
      connection — General Connection Profile Settings
      
+
      connection —  General Connection Profile Settings
      
       		
 
 
      
@@ -57,157 +57,169 @@
 
      auth-retries
      
 
      int32
      
 
      -1
      
-The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection. Currently, this only applies to 802-1x authentication.
+ 
 
 
 
      autoconnect
      
 
      boolean
      
 
      TRUE
      
-Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection. Autoconnect happens when the circumstances are suitable. That means for example that the device is currently managed and not active. Autoconnect thus never replaces or competes with an already active profile. Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles. If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined. Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.
+ 
 
 
 
      autoconnect-priority
      
 
      int32
      
 
      0
      
-The autoconnect priority in range -999 to 999. If the connection is set to autoconnect, connections with higher priority will be preferred. The higher number means higher priority. Defaults to 0. Note that this property only matters if there are more than one candidate profile to select for autoconnect. In case of equal priority, the profile used most recently is chosen.
+ 
 
 
 
      autoconnect-retries
      
 
      int32
      
 
      -1
      
-The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again.
+ 
 
 
 
      autoconnect-slaves
      
 
      NMSettingConnectionAutoconnectSlaves (int32)
      
 
      
-Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0.
+ 
 
 
 
      dns-over-tls
      
 
      int32
      
 
      -1
      
-Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic. The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don't ever use DNSOverTls. If unspecified "default" depends on the plugin used. Systemd-resolved uses global setting. This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.
+ 
 
 
 
      gateway-ping-timeout
      
 
      uint32
      
 
      0
      
-If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.
+ 
 
 
 
      id
      
 
      string
      
 
      
-A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".
+ 
 
 
 
      interface-name
      
 
      string
      
 
      
-The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings). For software devices this specifies the name of the created device. For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.
+ 
 
 
 
      lldp
      
 
      int32
      
 
      -1
      
-Whether LLDP is enabled for the connection.
+ 
 
 
 
      llmnr
      
 
      int32
      
 
      -1
      
-Whether Link-Local Multicast Name Resolution (LLMNR) is enabled for the connection. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link. The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes"). This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.
+ 
 
 
 
      master
      
 
      string
      
 
      
-Interface name of the master device or UUID of the master connection.
+ 
 
 
 
      mdns
      
 
      int32
      
 
      -1
      
-Whether mDNS is enabled for the connection. The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (-1) to allow lookup of a global default in NetworkManager.conf. If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "no"). This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.
+ 
 
 
 
      metered
      
 
      NMMetered (int32)
      
 
      
-Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately.
+ 
+
+
+
      mptcp-flags
      
+
      uint32
      
+
      0
      
+ 
 
 
 
      mud-url
      
 
      string
      
 
      
-If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer-recommended network policies for IoT devices. It is transmitted as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://". The special value "none" is allowed to indicate that no MUD URL is used. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".
+ 
 
 
 
      multi-connect
      
 
      int32
      
 
      0
      
-Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.
+ 
 
 
 
      permissions
      
 
      array of string
      
 
      
-An array of strings defining what access a given user has to this connection.  If this is NULL or empty, all users are allowed to access this connection; otherwise users are allowed if and only if they are in this list.  When this is not empty, the connection can be active only when one of the specified users is logged into an active session.  Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". At this time only the "user" [type] is allowed.  Any other values are ignored and reserved for future use.  [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use.  All of [type], [id], and [reserved] must be valid UTF-8.
+ 
 
 
 
      read-only
      
 
      boolean
      
 
      FALSE
      
-FALSE if the connection can be modified using the provided settings service's D-Bus interface with the right privileges, or TRUE if the connection is read-only and cannot be modified.
+ 
 
 
 
      secondaries
      
 
      array of string
      
 
      
-List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.
+ 
 
 
 
      slave-type
      
 
      string
      
 
      
-Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.
+ 
 
 
 
      stable-id
      
 
      string
      
 
      
-This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context. The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used as DHCP client identifier with ipv4.dhcp-client-id=stable and to derive the DHCP DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid]. Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key. See NetworkManager(8) manual about the secret-key and the host identity. The '$' character is treated special to perform dynamic substitutions at runtime. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-boot, or every time. Note that "${DEVICE}" corresponds to the interface name of the device and "${MAC}" is the permanent MAC address of the device. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates. If the value is unset, a global connection default is consulted. If the value is still unset, the default is similar to "${CONNECTION}" and uses a unique, fixed ID for the connection.
+ 
 
 
 
      timestamp
      
 
      uint64
      
 
      0
      
-The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated. NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).
+ 
 
 
 
      type
      
 
      string
      
 
      
-Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).
+ 
 
 
 
      uuid
      
 
      string
      
 
      
-A universally unique identifier for the connection, for example generated with libuuid.  It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network.  For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes. The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").
+ 
+
+
+
      wait-activation-delay
      
+
      int32
      
+
      -1
      
+ 
 
 
 
      wait-device-timeout
      
 
      int32
      
 
      -1
      
-Timeout in milliseconds to wait for device at startup. During boot, devices may take a while to be detected by the driver. This property will cause to delay NetworkManager-wait-online.service and nm-online to give the device a chance to appear. This works by waiting for the given timeout until a compatible device for the profile is available and managed. The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.
+ 
 
 
 
      zone
      
 
      string
      
 
      
-The trust level of a the connection.  Free form case-insensitive string (for example "Home", "Work", "Public").  NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall. When updating this property on a currently activated connection, the change takes effect immediately.
+ 
 
 
 
      
diff --git a/docs/api/html/settings-dcb.html b/docs/api/html/settings-dcb.html
index b4df6ea6..f99db147 100644
--- a/docs/api/html/settings-dcb.html
+++ b/docs/api/html/settings-dcb.html
@@ -29,7 +29,7 @@
 
      
 
 
      dcb
      
-
      dcb — Data Center Bridging Settings
      
+
      dcb —  Data Center Bridging Settings
      
       		
 
 
      
@@ -57,91 +57,91 @@
 
      app-fcoe-flags
      
 
      NMSettingDcbFlags (uint32)
      
 
      
-Specifies the NMSettingDcbFlags for the DCB FCoE application.  Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).
+ 
 
 
 
      app-fcoe-mode
      
 
      string
      
 
      
-The FCoE controller mode; either "fabric" or "vn2vn". Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".
+ 
 
 
 
      app-fcoe-priority
      
 
      int32
      
 
      -1
      
-The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority.  Only used when the "app-fcoe-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.
+ 
 
 
 
      app-fip-flags
      
 
      NMSettingDcbFlags (uint32)
      
 
      
-Specifies the NMSettingDcbFlags for the DCB FIP application.  Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).
+ 
 
 
 
      app-fip-priority
      
 
      int32
      
 
      -1
      
-The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority.  Only used when the "app-fip-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.
+ 
 
 
 
      app-iscsi-flags
      
 
      NMSettingDcbFlags (uint32)
      
 
      
-Specifies the NMSettingDcbFlags for the DCB iSCSI application.  Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).
+ 
 
 
 
      app-iscsi-priority
      
 
      int32
      
 
      -1
      
-The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.
+ 
 
 
 
      priority-bandwidth
      
 
      array of uint32
      
 
      
-An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use.  The sum of all percentages for priorities which belong to the same group must total 100 percents.
+ 
 
 
 
      priority-flow-control
      
 
      array of uint32
      
 
      
-An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.
+ 
 
 
 
      priority-flow-control-flags
      
 
      NMSettingDcbFlags (uint32)
      
 
      
-Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).
+ 
 
 
 
      priority-group-bandwidth
      
 
      array of uint32
      
 
      
-An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group.  Allowed values are 0 - 100, and the sum of all values must total 100 percents.
+ 
 
 
 
      priority-group-flags
      
 
      NMSettingDcbFlags (uint32)
      
 
      
-Specifies the NMSettingDcbFlags for DCB Priority Groups.  Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).
+ 
 
 
 
      priority-group-id
      
 
      array of uint32
      
 
      
-An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID.  Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.
+ 
 
 
 
      priority-strict-bandwidth
      
 
      array of uint32
      
 
      
-An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.
+ 
 
 
 
      priority-traffic-class
      
 
      array of uint32
      
 
      
-An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.
+ 
 
 
 
      
diff --git a/docs/api/html/settings-dummy.html b/docs/api/html/settings-dummy.html
index 027121fe..efdb69b3 100644
--- a/docs/api/html/settings-dummy.html
+++ b/docs/api/html/settings-dummy.html
@@ -29,7 +29,7 @@
 
      
 
 
      dummy
      
-
      dummy — Dummy Link Settings
      
+
      dummy —  Dummy Link Settings
      
       		
 
 
      
diff --git a/docs/api/html/settings-ethtool.html b/docs/api/html/settings-ethtool.html
index 42717eb2..8f7d443b 100644
--- a/docs/api/html/settings-ethtool.html
+++ b/docs/api/html/settings-ethtool.html
@@ -29,7 +29,7 @@
 
      
 
 
      ethtool
      
-
      ethtool — Ethtool Ethernet Settings
      
+
      ethtool —  Ethtool Ethernet Settings
      
       		
 
 
      
diff --git a/docs/api/html/settings-generic.html b/docs/api/html/settings-generic.html
index c6a5a552..efe5a89a 100644
--- a/docs/api/html/settings-generic.html
+++ b/docs/api/html/settings-generic.html
@@ -29,7 +29,7 @@
 
      
 
 
      generic
      
-
      generic — Generic Link Settings
      
+
      generic —  Generic Link Settings
      
       		
 
 
      
diff --git a/docs/api/html/settings-gsm.html b/docs/api/html/settings-gsm.html
index 682118ee..2834c46d 100644
--- a/docs/api/html/settings-gsm.html
+++ b/docs/api/html/settings-gsm.html
@@ -29,7 +29,7 @@
 
      
 
 
      gsm
      
-
      gsm — GSM-based Mobile Broadband Settings
      
+
      gsm —  GSM-based Mobile Broadband Settings
      
       		
 
 
      
@@ -57,85 +57,85 @@
 
      apn
      
 
      string
      
 
      
-The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network.  The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.
+ 
 
 
 
      auto-config
      
 
      boolean
      
 
      FALSE
      
-When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.
+ 
 
 
 
      device-id
      
 
      string
      
 
      
-The device unique identifier (as given by the WWAN management service) which this connection applies to.  If given, the connection will only apply to the specified device.
+ 
 
 
 
      home-only
      
 
      boolean
      
 
      FALSE
      
-When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.
+ 
 
 
 
      mtu
      
 
      uint32
      
 
      0
      
-If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.
+ 
 
 
 
      network-id
      
 
      string
      
 
      
-The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration.  If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.
+ 
 
 
 
      number
      
 
      string
      
 
      
-Legacy setting that used to help establishing PPP data sessions for GSM-based modems. Deprecated: 1
+ 
 
 
 
      password
      
 
      string
      
 
      
-The password used to authenticate with the network, if required.  Many providers do not require a password, or accept any password.  But if a password is required, it is specified here.
+ 
 
 
 
      password-flags
      
 
      NMSettingSecretFlags (uint32)
      
 
      
-Flags indicating how to handle the "password" property.
+ 
 
 
 
      pin
      
 
      string
      
 
      
-If the SIM is locked with a PIN it must be unlocked before any other operations are requested.  Specify the PIN here to allow operation of the device.
+ 
 
 
 
      pin-flags
      
 
      NMSettingSecretFlags (uint32)
      
 
      
-Flags indicating how to handle the "pin" property.
+ 
 
 
 
      sim-id
      
 
      string
      
 
      
-The SIM card unique identifier (as given by the WWAN management service) which this connection applies to.  If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.
+ 
 
 
 
      sim-operator-id
      
 
      string
      
 
      
-A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to.  If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.
+ 
 
 
 
      username
      
 
      string
      
 
      
-The username used to authenticate with the network, if required.  Many providers do not require a username, or accept any username.  But if a username is required, it is specified here.
+ 
 
 
 
      
diff --git a/docs/api/html/settings-hostname.html b/docs/api/html/settings-hostname.html
index 52e0d5fe..d6110465 100644
--- a/docs/api/html/settings-hostname.html
+++ b/docs/api/html/settings-hostname.html
@@ -29,7 +29,7 @@
 
      
 
 
      hostname
      
-
      hostname — Hostname settings
      
+
      hostname —  Hostname settings
      
       		
 
 
      
@@ -57,25 +57,25 @@
 
      from-dhcp
      
 
      NMTernary (int32)
      
 
      
-Whether the system hostname can be determined from DHCP on this connection. When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).
+ 
 
 
 
      from-dns-lookup
      
 
      NMTernary (int32)
      
 
      
-Whether the system hostname can be determined from reverse DNS lookup of addresses on this device. When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).
+ 
 
 
 
      only-from-default
      
 
      NMTernary (int32)
      
 
      
-If set to NM_TERNARY_TRUE (1), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6). If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn't have the default route. When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_FALSE (0).
+ 
 
 
 
      priority
      
 
      int32
      
 
      0
      
-The relative priority of this connection to determine the system hostname. A lower numerical value is better (higher priority).  A connection with higher priority is considered before connections with lower priority. If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100. Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname.
+ 
 
 
 
      
diff --git a/docs/api/html/settings-infiniband.html b/docs/api/html/settings-infiniband.html
index 2d7ffa9a..317a26a5 100644
--- a/docs/api/html/settings-infiniband.html
+++ b/docs/api/html/settings-infiniband.html
@@ -29,7 +29,7 @@
 
      
 
 
      infiniband
      
-
      infiniband — Infiniband Settings
      
+
      infiniband —  Infiniband Settings
      
       		
 
 
      
@@ -57,31 +57,31 @@
 
      mac-address
      
 
      byte array
      
 
      
-If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).
+ 
 
 
 
      mtu
      
 
      uint32
      
 
      0
      
-If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.
+ 
 
 
 
      p-key
      
 
      int32
      
 
      -1
      
-The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key.
+ 
 
 
 
      parent
      
 
      string
      
 
      
-The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".
+ 
 
 
 
      transport-mode
      
 
      string
      
 
      
-The IP-over-InfiniBand transport mode. Either "datagram" or "connected".
+ 
 
 
 
      
diff --git a/docs/api/html/settings-ip-tunnel.html b/docs/api/html/settings-ip-tunnel.html
index 859675bc..cd464bac 100644
--- a/docs/api/html/settings-ip-tunnel.html
+++ b/docs/api/html/settings-ip-tunnel.html
@@ -29,7 +29,7 @@
 
      
 
 
      ip-tunnel
      
-
      ip-tunnel — IP Tunneling Settings
      
+
      ip-tunnel —  IP Tunneling Settings
      
       		
 
 
      
@@ -57,79 +57,79 @@
 
      encapsulation-limit
      
 
      uint32
      
 
      0
      
-How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.
+ 
 
 
 
      flags
      
 
      uint32
      
 
      0
      
-Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.
+ 
 
 
 
      flow-label
      
 
      uint32
      
 
      0
      
-The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.
+ 
 
 
 
      input-key
      
 
      string
      
 
      
-The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.
+ 
 
 
 
      local
      
 
      string
      
 
      
-The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.
+ 
 
 
 
      mode
      
 
      uint32
      
 
      0
      
-The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).
+ 
 
 
 
      mtu
      
 
      uint32
      
 
      0
      
-If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.
+ 
 
 
 
      output-key
      
 
      string
      
 
      
-The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.
+ 
 
 
 
      parent
      
 
      string
      
 
      
-If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.
+ 
 
 
 
      path-mtu-discovery
      
 
      boolean
      
 
      TRUE
      
-Whether to enable Path MTU Discovery on this tunnel.
+ 
 
 
 
      remote
      
 
      string
      
 
      
-The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.
+ 
 
 
 
      tos
      
 
      uint32
      
 
      0
      
-The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.
+ 
 
 
 
      ttl
      
 
      uint32
      
 
      0
      
-The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.
+ 
 
 
 
      
diff --git a/docs/api/html/settings-ipv4.html b/docs/api/html/settings-ipv4.html
index f4a9c416..a933d551 100644
--- a/docs/api/html/settings-ipv4.html
+++ b/docs/api/html/settings-ipv4.html
@@ -29,7 +29,7 @@
 
      
 
 
      ipv4
      
-
      ipv4 — IPv4 Settings
      
+
      ipv4 —  IPv4 Settings
      
       		
 
 
      
@@ -57,163 +57,169 @@
 
      address-data
      
 
      array of vardict
      
 
      
-Array of IPv4 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.
+ 
 
 
 
      addresses
      
 
      array of array of uint32
      
 
      
-Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'.  Array of IPv4 address structures.  Each IPv4 address structure is composed of 3 32-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 - 32), and last the IPv4 gateway (network byte order). The gateway may be left as 0 if no gateway exists for that subnet.
+ 
 
 
 
      dad-timeout
      
 
      int32
      
 
      -1
      
-Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network.  If an address conflict is detected, the activation will fail.  A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero).  A value greater than zero is a timeout in milliseconds. The property is currently implemented only for IPv4.
+ 
 
 
 
      dhcp-client-id
      
 
      string
      
 
      
-A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0. The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links. The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset. The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id. The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key. If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin.
+ 
 
 
 
      dhcp-fqdn
      
 
      string
      
 
      
-If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.
+ 
 
 
 
      dhcp-hostname
      
 
      string
      
 
      
-If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.
+ 
 
 
 
      dhcp-hostname-flags
      
 
      uint32
      
 
      0
      
-Flags for the DHCP hostname and FQDN. Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4).  When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.
+ 
 
 
 
      dhcp-iaid
      
 
      string
      
 
      
-A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.
+ 
 
 
 
      dhcp-reject-servers
      
 
      array of string
      
 
      
-Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). This property is currently not implemented for DHCPv6.
+ 
 
 
 
      dhcp-send-hostname
      
 
      boolean
      
 
      TRUE
      
-If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer.  If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.
+ 
 
 
 
      dhcp-timeout
      
 
      int32
      
 
      0
      
-A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). Set to 2147483647 (MAXINT32) for infinity.
+ 
 
 
 
      dhcp-vendor-class-identifier
      
 
      string
      
 
      
-The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server. Since 1.28
+ 
 
 
 
      dns
      
 
      array of uint32
      
 
      
-Array of IP addresses of DNS servers (as network-byte-order integers)
+ 
 
 
 
      dns-options
      
 
      array of string
      
 
      
-Array of DNS options as described in man 5 resolv.conf. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties. The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.
+ 
 
 
 
      dns-priority
      
 
      int32
      
 
      0
      
-DNS servers priority. The relative priority for DNS servers specified by this setting.  A lower numerical value is better (higher priority). Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections. Note that the priority is to order DNS settings for multiple active connections.  It does not disambiguate multiple DNS servers within the same connection profile. When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain.  Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually).  When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins.  If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.
+ 
 
 
 
      dns-search
      
 
      array of string
      
 
      
-Array of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names. When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.
+ 
 
 
 
      gateway
      
 
      string
      
 
      
-The gateway associated with this configuration. This is only meaningful if "addresses" is also set. The gateway's main purpose is to control the next hop of the standard default route on the device. Hence, the gateway property conflicts with "never-default" and will be automatically dropped if the IP configuration is set to never-default. As an alternative to set the gateway, configure a static default route with /0 as prefix length.
+ 
 
 
 
      ignore-auto-dns
      
 
      boolean
      
 
      FALSE
      
-When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.
+ 
 
 
 
      ignore-auto-routes
      
 
      boolean
      
 
      FALSE
      
-When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.
+ 
+
+
+
      link-local
      
+
      int32
      
+
      0
      
+ 
 
 
 
      may-fail
      
 
      boolean
      
 
      TRUE
      
-If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out.  Note that at least one IP configuration must succeed or overall network configuration will still fail.  For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.
+ 
 
 
 
      method
      
 
      string
      
 
      
-IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration.  The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.
+ 
 
 
 
      never-default
      
 
      boolean
      
 
      FALSE
      
-If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.
+ 
 
 
 
      required-timeout
      
 
      int32
      
 
      -1
      
-The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).
+ 
 
 
 
      route-data
      
 
      array of vardict
      
 
      
-Array of IPv4 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.
+ 
 
 
 
      route-metric
      
 
      int64
      
 
      -1
      
-The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.
+ 
 
 
 
      route-table
      
 
      uint32
      
 
      0
      
-Enable policy routing (source routing) and set the routing table used when adding routes. This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.
+ 
 
 
 
      routes
      
 
      array of array of uint32
      
 
      
-Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'.  Array of IPv4 route structures.  Each IPv4 route structure is composed of 4 32-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 - 32), the third being the next-hop (network byte order) if any, and the fourth being the route metric. If the metric is 0, NM will choose an appropriate default metric for the device. (There is no way to explicitly specify an actual metric of 0 with this property.)
+ 
 
 
 
      
diff --git a/docs/api/html/settings-ipv6.html b/docs/api/html/settings-ipv6.html
index e0965661..b5ce52e6 100644
--- a/docs/api/html/settings-ipv6.html
+++ b/docs/api/html/settings-ipv6.html
@@ -29,7 +29,7 @@
 
      
 
 
      ipv6
      
-
      ipv6 — IPv6 Settings
      
+
      ipv6 —  IPv6 Settings
      
       		
 
 
      
@@ -56,176 +56,182 @@
 
 
      addr-gen-mode
      
 
      int32
      
-
      1
      
-Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced. The value of stable-privacy enables use of cryptographically secure hash of a secret host-specific key along with the connection's stable-id and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced. On D-Bus, the absence of an addr-gen-mode setting equals enabling stable-privacy. For keyfile plugin, the absence of the setting on disk means EUI64 so that the property doesn't change on upgrade from older versions. Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.
+
      3
      
+ 
 
 
 
      address-data
      
 
      array of vardict
      
 
      
-Array of IPv6 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.
+ 
 
 
 
      addresses
      
 
      array of legacy IPv6 address struct (a(ayuay))
      
 
      
-Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'.  Array of IPv6 address structures.  Each IPv6 address structure is composed of an IPv6 address, a prefix length (1 - 128), and an IPv6 gateway address. The gateway may be zeroed out if no gateway exists for that subnet.
+ 
 
 
 
      dad-timeout
      
 
      int32
      
 
      -1
      
-Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network.  If an address conflict is detected, the activation will fail.  A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero).  A value greater than zero is a timeout in milliseconds. The property is currently implemented only for IPv4.
+ 
 
 
 
      dhcp-duid
      
 
      string
      
 
      
-A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option. The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id. The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk. The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt"). When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.
+ 
 
 
 
      dhcp-hostname
      
 
      string
      
 
      
-If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.
+ 
 
 
 
      dhcp-hostname-flags
      
 
      uint32
      
 
      0
      
-Flags for the DHCP hostname and FQDN. Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4).  When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.
+ 
 
 
 
      dhcp-iaid
      
 
      string
      
 
      
-A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.
+ 
 
 
 
      dhcp-reject-servers
      
 
      array of string
      
 
      
-Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). This property is currently not implemented for DHCPv6.
+ 
 
 
 
      dhcp-send-hostname
      
 
      boolean
      
 
      TRUE
      
-If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer.  If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.
+ 
 
 
 
      dhcp-timeout
      
 
      int32
      
 
      0
      
-A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). Set to 2147483647 (MAXINT32) for infinity.
+ 
 
 
 
      dns
      
 
      array of byte array
      
 
      
-Array of IP addresses of DNS servers (in network byte order)
+ 
 
 
 
      dns-options
      
 
      array of string
      
 
      
-Array of DNS options as described in man 5 resolv.conf. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties. The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.
+ 
 
 
 
      dns-priority
      
 
      int32
      
 
      0
      
-DNS servers priority. The relative priority for DNS servers specified by this setting.  A lower numerical value is better (higher priority). Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections. Note that the priority is to order DNS settings for multiple active connections.  It does not disambiguate multiple DNS servers within the same connection profile. When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain.  Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually).  When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins.  If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.
+ 
 
 
 
      dns-search
      
 
      array of string
      
 
      
-Array of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names. When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.
+ 
 
 
 
      gateway
      
 
      string
      
 
      
-The gateway associated with this configuration. This is only meaningful if "addresses" is also set. The gateway's main purpose is to control the next hop of the standard default route on the device. Hence, the gateway property conflicts with "never-default" and will be automatically dropped if the IP configuration is set to never-default. As an alternative to set the gateway, configure a static default route with /0 as prefix length.
+ 
 
 
 
      ignore-auto-dns
      
 
      boolean
      
 
      FALSE
      
-When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.
+ 
 
 
 
      ignore-auto-routes
      
 
      boolean
      
 
      FALSE
      
-When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.
+ 
 
 
 
      ip6-privacy
      
 
      NMSettingIP6ConfigPrivacy (int32)
      
 
      
-Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941.  If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64.  This enhances privacy, but could cause problems in some applications, on the other hand.  The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses). Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy". If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr". Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.
+ 
 
 
 
      may-fail
      
 
      boolean
      
 
      TRUE
      
-If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out.  Note that at least one IP configuration must succeed or overall network configuration will still fail.  For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.
+ 
 
 
 
      method
      
 
      string
      
 
      
-IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration.  The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.
+ 
+
+
+
      mtu
      
+
      uint32
      
+
      0
      
+ 
 
 
 
      never-default
      
 
      boolean
      
 
      FALSE
      
-If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.
+ 
 
 
 
      ra-timeout
      
 
      int32
      
 
      0
      
-A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device. Set to 2147483647 (MAXINT32) for infinity.
+ 
 
 
 
      required-timeout
      
 
      int32
      
 
      -1
      
-The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).
+ 
 
 
 
      route-data
      
 
      array of vardict
      
 
      
-Array of IPv6 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.
+ 
 
 
 
      route-metric
      
 
      int64
      
 
      -1
      
-The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.
+ 
 
 
 
      route-table
      
 
      uint32
      
 
      0
      
-Enable policy routing (source routing) and set the routing table used when adding routes. This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.
+ 
 
 
 
      routes
      
 
      array of legacy IPv6 route struct (a(ayuayu))
      
 
      
-Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'.  Array of IPv6 route structures.  Each IPv6 route structure is composed of an IPv6 address, a prefix length (1 - 128), an IPv6 next hop address (which may be zeroed out if there is no next hop), and a metric. If the metric is 0, NM will choose an appropriate default metric for the device.
+ 
 
 
 
      token
      
 
      string
      
 
      
-Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.
+ 
 
 
 
      
diff --git a/docs/api/html/settings-macsec.html b/docs/api/html/settings-macsec.html
index 27228aa6..72e103d0 100644
--- a/docs/api/html/settings-macsec.html
+++ b/docs/api/html/settings-macsec.html
@@ -29,7 +29,7 @@
 
      
 
 
      macsec
      
-
      macsec — MACSec Settings
      
+
      macsec —  MACSec Settings
      
       		
 
 
      
@@ -57,55 +57,55 @@
 
      encrypt
      
 
      boolean
      
 
      TRUE
      
-Whether the transmitted traffic must be encrypted.
+ 
 
 
 
      mka-cak
      
 
      string
      
 
      
-The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement.
+ 
 
 
 
      mka-cak-flags
      
 
      NMSettingSecretFlags (uint32)
      
 
      
-Flags indicating how to handle the "mka-cak" property.
+ 
 
 
 
      mka-ckn
      
 
      string
      
 
      
-The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement.
+ 
 
 
 
      mode
      
 
      int32
      
 
      0
      
-Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.
+ 
 
 
 
      parent
      
 
      string
      
 
      
-If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created.  If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.
+ 
 
 
 
      port
      
 
      int32
      
 
      1
      
-The port component of the SCI (Secure Channel Identifier), between 1 and 65534.
+ 
 
 
 
      send-sci
      
 
      boolean
      
 
      TRUE
      
-Specifies whether the SCI (Secure Channel Identifier) is included in every packet.
+ 
 
 
 
      validation
      
 
      int32
      
 
      2
      
-Specifies the validation mode for incoming frames.
+ 
 
 
 
      
diff --git a/docs/api/html/settings-macvlan.html b/docs/api/html/settings-macvlan.html
index 554d61d5..aec99676 100644
--- a/docs/api/html/settings-macvlan.html
+++ b/docs/api/html/settings-macvlan.html
@@ -29,7 +29,7 @@
 
      
 
 
      macvlan
      
-
      macvlan — MAC VLAN Settings
      
+
      macvlan —  MAC VLAN Settings
      
       		
 
 
      
@@ -57,25 +57,25 @@
 
      mode
      
 
      uint32
      
 
      0
      
-The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.
+ 
 
 
 
      parent
      
 
      string
      
 
      
-If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created.  If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.
+ 
 
 
 
      promiscuous
      
 
      boolean
      
 
      TRUE
      
-Whether the interface should be put in promiscuous mode.
+ 
 
 
 
      tap
      
 
      boolean
      
 
      FALSE
      
-Whether the interface should be a MACVTAP.
+ 
 
 
 
      
diff --git a/docs/api/html/settings-match.html b/docs/api/html/settings-match.html
index 20a077fc..2c483f94 100644
--- a/docs/api/html/settings-match.html
+++ b/docs/api/html/settings-match.html
@@ -29,7 +29,7 @@
 
      
 
 
      match
      
-
      match — Match settings
      
+
      match —  Match settings
      
       		
 
 
      
@@ -57,25 +57,25 @@
 
      driver
      
 
      array of string
      
 
      
-A list of driver names to match. Each element is a shell wildcard pattern. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.
+ 
 
 
 
      interface-name
      
 
      array of string
      
 
      
-A list of interface names to match. Each element is a shell wildcard pattern. An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".
+ 
 
 
 
      kernel-command-line
      
 
      array of string
      
 
      
-A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.
+ 
 
 
 
      path
      
 
      array of string
      
 
      
-A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier. For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0". The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev"). Each element of the list is a shell wildcard pattern. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.
+ 
 
 
 
    
diff --git a/docs/api/html/settings-ovs-bridge.html b/docs/api/html/settings-ovs-bridge.html
index 9754e4bf..6977650b 100644
--- a/docs/api/html/settings-ovs-bridge.html
+++ b/docs/api/html/settings-ovs-bridge.html
@@ -29,7 +29,7 @@
 
    
 
 
    ovs-bridge
    
-
    ovs-bridge — OvsBridge Link Settings
    
+
    ovs-bridge —  OvsBridge Link Settings
    
     		
 
 
    
@@ -57,31 +57,31 @@
 
    datapath-type
    
 
    string
    
 
    
-The data path type. One of "system", "netdev" or empty.
+ 
 
 
 
    fail-mode
    
 
    string
    
 
    
-The bridge failure mode. One of "secure", "standalone" or empty.
+ 
 
 
 
    mcast-snooping-enable
    
 
    boolean
    
 
    FALSE
    
-Enable or disable multicast snooping.
+ 
 
 
 
    rstp-enable
    
 
    boolean
    
 
    FALSE
    
-Enable or disable RSTP.
+ 
 
 
 
    stp-enable
    
 
    boolean
    
 
    FALSE
    
-Enable or disable STP.
+ 
 
 
 
    
diff --git a/docs/api/html/settings-ovs-dpdk.html b/docs/api/html/settings-ovs-dpdk.html
index 74445249..959b44c1 100644
--- a/docs/api/html/settings-ovs-dpdk.html
+++ b/docs/api/html/settings-ovs-dpdk.html
@@ -29,7 +29,7 @@
 
    
 
 
    ovs-dpdk
    
-
    ovs-dpdk — OvsDpdk Link Settings
    
+
    ovs-dpdk —  OvsDpdk Link Settings
    
     		
 
 
    
@@ -57,13 +57,13 @@
 
    devargs
    
 
    string
    
 
    
-Open vSwitch DPDK device arguments.
+ 
 
 
 
    n-rxq
    
 
    uint32
    
 
    0
    
-Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.
+ 
 
 
 

diff --git a/docs/api/html/settings-ovs-external-ids.html b/docs/api/html/settings-ovs-external-ids.html
index d3f0657f..21de0dc0 100644
--- a/docs/api/html/settings-ovs-external-ids.html
+++ b/docs/api/html/settings-ovs-external-ids.html
@@ -29,7 +29,7 @@
 

 
 
ovs-external-ids

-
ovs-external-ids — OVS External IDs Settings

+
ovs-external-ids —  OVS External IDs Settings

 		
 
 

@@ -56,7 +56,7 @@
 
data

 
dict of string to string

 
{}

-A dictionary of key/value pairs with exernal-ids for OVS.
+ 
 
 

 

diff --git a/docs/api/html/settings-ovs-interface.html b/docs/api/html/settings-ovs-interface.html
index 41f2c8a3..22dc57f7 100644
--- a/docs/api/html/settings-ovs-interface.html
+++ b/docs/api/html/settings-ovs-interface.html
@@ -29,7 +29,7 @@
 

 
 
ovs-interface

-
ovs-interface — Open vSwitch Interface Settings

+
ovs-interface —  Open vSwitch Interface Settings

 		
 
 

@@ -56,7 +56,7 @@
 
type

 
string

 

-The interface type. Either "internal", "system", "patch", "dpdk", or empty.
+ 
 
 

 

diff --git a/docs/api/html/settings-ovs-patch.html b/docs/api/html/settings-ovs-patch.html
index 2b755089..f5e5990f 100644
--- a/docs/api/html/settings-ovs-patch.html
+++ b/docs/api/html/settings-ovs-patch.html
@@ -29,7 +29,7 @@
 

 
 
ovs-patch

-
ovs-patch — OvsPatch Link Settings

+
ovs-patch —  OvsPatch Link Settings

 		
 
 

@@ -56,7 +56,7 @@
 
peer

 
string

 

-Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.
+ 
 
 

 

diff --git a/docs/api/html/settings-ovs-port.html b/docs/api/html/settings-ovs-port.html
index 6ca34831..736c7923 100644
--- a/docs/api/html/settings-ovs-port.html
+++ b/docs/api/html/settings-ovs-port.html
@@ -29,7 +29,7 @@
 

 
 
ovs-port

-
ovs-port — OvsPort Link Settings

+
ovs-port —  OvsPort Link Settings

 		
 
 

@@ -57,37 +57,37 @@
 
bond-downdelay

 
uint32

 
0

-The time port must be inactive in order to be considered down.
+ 
 
 
 
bond-mode

 
string

 

-Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".
+ 
 
 
 
bond-updelay

 
uint32

 
0

-The time port must be active before it starts forwarding traffic.
+ 
 
 
 
lacp

 
string

 

-LACP mode. One of "active", "off", or "passive".
+ 
 
 
 
tag

 
uint32

 
0

-The VLAN tag in the range 0-4095.
+ 
 
 
 
vlan-mode

 
string

 

-The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk" or unset.
+ 
 
 
 

diff --git a/docs/api/html/settings-ppp.html b/docs/api/html/settings-ppp.html
index fea6add6..62f673d9 100644
--- a/docs/api/html/settings-ppp.html
+++ b/docs/api/html/settings-ppp.html
@@ -29,7 +29,7 @@
 

 
 
ppp

-
ppp — Point-to-Point Protocol Settings

+
ppp —  Point-to-Point Protocol Settings

 		
 
 

@@ -57,109 +57,109 @@
 
baud

 
uint32

 
0

-If non-zero, instruct pppd to set the serial port to the specified baudrate.  This value should normally be left as 0 to automatically choose the speed.
+ 
 
 
 
crtscts

 
boolean

 
FALSE

-If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals.  This value should normally be set to FALSE.
+ 
 
 
 
lcp-echo-failure

 
uint32

 
0

-If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer.  The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.
+ 
 
 
 
lcp-echo-interval

 
uint32

 
0

-If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value).  Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.
+ 
 
 
 
mppe-stateful

 
boolean

 
FALSE

-If TRUE, stateful MPPE is used.  See pppd documentation for more information on stateful MPPE.
+ 
 
 
 
mru

 
uint32

 
0

-If non-zero, instruct pppd to request that the peer send packets no larger than the specified size.  If non-zero, the MRU should be between 128 and 16384.
+ 
 
 
 
mtu

 
uint32

 
0

-If non-zero, instruct pppd to send packets no larger than the specified size.
+ 
 
 
 
no-vj-comp

 
boolean

 
FALSE

-If TRUE, Van Jacobsen TCP header compression will not be requested.
+ 
 
 
 
noauth

 
boolean

 
TRUE

-If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client.  If FALSE, require authentication from the remote side.  In almost all cases, this should be TRUE.
+ 
 
 
 
nobsdcomp

 
boolean

 
FALSE

-If TRUE, BSD compression will not be requested.
+ 
 
 
 
nodeflate

 
boolean

 
FALSE

-If TRUE, "deflate" compression will not be requested.
+ 
 
 
 
refuse-chap

 
boolean

 
FALSE

-If TRUE, the CHAP authentication method will not be used.
+ 
 
 
 
refuse-eap

 
boolean

 
FALSE

-If TRUE, the EAP authentication method will not be used.
+ 
 
 
 
refuse-mschap

 
boolean

 
FALSE

-If TRUE, the MSCHAP authentication method will not be used.
+ 
 
 
 
refuse-mschapv2

 
boolean

 
FALSE

-If TRUE, the MSCHAPv2 authentication method will not be used.
+ 
 
 
 
refuse-pap

 
boolean

 
FALSE

-If TRUE, the PAP authentication method will not be used.
+ 
 
 
 
require-mppe

 
boolean

 
FALSE

-If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session.  If either 64-bit or 128-bit MPPE is not available the session will fail.  Note that MPPE is not used on mobile broadband connections.
+ 
 
 
 
require-mppe-128

 
boolean

 
FALSE

-If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE.  If 128-bit MPPE is not available the session will fail.
+ 
 
 
 

diff --git a/docs/api/html/settings-pppoe.html b/docs/api/html/settings-pppoe.html
index f91ed115..8d36c318 100644
--- a/docs/api/html/settings-pppoe.html
+++ b/docs/api/html/settings-pppoe.html
@@ -29,7 +29,7 @@
 

 
 
pppoe

-
pppoe — PPP-over-Ethernet Settings

+
pppoe —  PPP-over-Ethernet Settings

 		
 
 

@@ -57,31 +57,31 @@
 
parent

 
string

 

-If given, specifies the parent interface name on which this PPPoE connection should be created.  If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.
+ 
 
 
 
password

 
string

 

-Password used to authenticate with the PPPoE service.
+ 
 
 
 
password-flags

 
NMSettingSecretFlags (uint32)

 

-Flags indicating how to handle the "password" property.
+ 
 
 
 
service

 
string

 

-If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service.  For most providers, this should be left blank.  It is only required if there are multiple access concentrators or a specific service is known to be required.
+ 
 
 
 
username

 
string

 

-Username used to authenticate with the PPPoE service.
+ 
 
 
 

diff --git a/docs/api/html/settings-proxy.html b/docs/api/html/settings-proxy.html
index 3f5a6248..d49e6fbd 100644
--- a/docs/api/html/settings-proxy.html
+++ b/docs/api/html/settings-proxy.html
@@ -29,7 +29,7 @@
 

 
 
proxy

-
proxy — WWW Proxy Settings

+
proxy —  WWW Proxy Settings

 		
 
 

@@ -57,25 +57,25 @@
 
browser-only

 
boolean

 
FALSE

-Whether the proxy configuration is for browser only.
+ 
 
 
 
method

 
int32

 
0

-Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)
+ 
 
 
 
pac-script

 
string

 

-PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.
+ 
 
 
 
pac-url

 
string

 

-PAC URL for obtaining PAC file.
+ 
 
 
 

diff --git a/docs/api/html/settings-serial.html b/docs/api/html/settings-serial.html
index 20ddfb5b..9112980b 100644
--- a/docs/api/html/settings-serial.html
+++ b/docs/api/html/settings-serial.html
@@ -29,7 +29,7 @@
 

 
 
serial

-
serial — Serial Link Settings

+
serial —  Serial Link Settings

 		
 
 

@@ -57,31 +57,31 @@
 
baud

 
uint32

 
57600

-Speed to use for communication over the serial port.  Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.
+ 
 
 
 
bits

 
uint32

 
8

-Byte-width of the serial communication. The 8 in "8n1" for example.
+ 
 
 
 
parity

 
byte

 

-The connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none.
+ 
 
 
 
send-delay

 
uint64

 
0

-Time to delay between each byte sent to the modem, in microseconds.
+ 
 
 
 
stopbits

 
uint32

 
1

-Number of stop bits for communication on the serial port.  Either 1 or 2. The 1 in "8n1" for example.
+ 
 
 
 

diff --git a/docs/api/html/settings-sriov.html b/docs/api/html/settings-sriov.html
index a9daf616..9000defc 100644
--- a/docs/api/html/settings-sriov.html
+++ b/docs/api/html/settings-sriov.html
@@ -29,7 +29,7 @@
 

 
 
sriov

-
sriov — SR-IOV settings

+
sriov —  SR-IOV settings

 		
 
 

@@ -57,19 +57,19 @@
 
autoprobe-drivers

 
NMTernary (int32)

 

-Whether to autoprobe virtual functions by a compatible driver. If set to NM_TERNARY_TRUE (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF. If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them. When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_TRUE (1).
+ 
 
 
 
total-vfs

 
uint32

 
0

-The total number of virtual functions to create. Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.
+ 
 
 
 
vfs

 
array of vardict

 

-Array of virtual function descriptors. Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF. When represented as string a VF is in the form: "INDEX [ATTR=VALUE[ ATTR=VALUE]...]". for example: "2 mac=00:11:22:33:44:55 spoof-check=true". Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans. The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form "ID[.PRIORITY[.PROTO]]". PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.
+ 
 
 
 

diff --git a/docs/api/html/settings-tc.html b/docs/api/html/settings-tc.html
index 9f4d53ee..dc1b3765 100644
--- a/docs/api/html/settings-tc.html
+++ b/docs/api/html/settings-tc.html
@@ -29,7 +29,7 @@
 

 
 
tc

-
tc — Linux Traffic Control Settings

+
tc —  Linux Traffic Control Settings

 		
 
 

@@ -57,13 +57,13 @@
 
qdiscs

 
array of vardict

 

-Array of TC queueing disciplines. When the "tc" setting is present, qdiscs from this property are applied upon activation. If the property is empty, all qdiscs are removed and the device will only have the default qdisc assigned by kernel according to the "net.core.default_qdisc" sysctl. If the "tc" setting is not present, NetworkManager doesn't touch the qdiscs present on the interface.
+ 
 
 
 
tfilters

 
array of vardict

 

-Array of TC traffic filters. When the "tc" setting is present, filters from this property are applied upon activation. If the property is empty, NetworkManager removes all the filters. If the "tc" setting is not present, NetworkManager doesn't touch the filters present on the interface.
+ 
 
 
 

diff --git a/docs/api/html/settings-team-port.html b/docs/api/html/settings-team-port.html
index dbbe038d..c8d05d09 100644
--- a/docs/api/html/settings-team-port.html
+++ b/docs/api/html/settings-team-port.html
@@ -29,7 +29,7 @@
 

 
 
team-port

-
team-port — Team Port Settings

+
team-port —  Team Port Settings

 		
 
 

@@ -57,43 +57,43 @@
 
config

 
string

 

-The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.
+ 
 
 
 
lacp-key

 
int32

 
-1

-Corresponds to the teamd ports.PORTIFNAME.lacp_key.
+ 
 
 
 
lacp-prio

 
int32

 
-1

-Corresponds to the teamd ports.PORTIFNAME.lacp_prio.
+ 
 
 
 
link-watchers

 
array of vardict

 

-Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are:   ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.
+ 
 
 
 
prio

 
int32

 
0

-Corresponds to the teamd ports.PORTIFNAME.prio.
+ 
 
 
 
queue-id

 
int32

 
-1

-Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.
+ 
 
 
 
sticky

 
boolean

 
FALSE

-Corresponds to the teamd ports.PORTIFNAME.sticky.
+ 
 
 
 

diff --git a/docs/api/html/settings-team.html b/docs/api/html/settings-team.html
index 412c7380..2a572ac5 100644
--- a/docs/api/html/settings-team.html
+++ b/docs/api/html/settings-team.html
@@ -29,7 +29,7 @@
 

 
 
team

-
team — Teaming Settings

+
team —  Teaming Settings

 		
 
 

@@ -57,103 +57,103 @@
 
config

 
string

 

-The JSON configuration for the team network interface.  The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used.  See man teamd.conf for the format details.
+ 
 
 
 
interface-name

 
string

 

-Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name.
+ 
 
 
 
link-watchers

 
array of vardict

 

-Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are:   ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.
+ 
 
 
 
mcast-rejoin-count

 
int32

 
-1

-Corresponds to the teamd mcast_rejoin.count.
+ 
 
 
 
mcast-rejoin-interval

 
int32

 
-1

-Corresponds to the teamd mcast_rejoin.interval.
+ 
 
 
 
notify-peers-count

 
int32

 
-1

-Corresponds to the teamd notify_peers.count.
+ 
 
 
 
notify-peers-interval

 
int32

 
-1

-Corresponds to the teamd notify_peers.interval.
+ 
 
 
 
runner

 
string

 

-Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".
+ 
 
 
 
runner-active

 
boolean

 
TRUE

-Corresponds to the teamd runner.active.
+ 
 
 
 
runner-agg-select-policy

 
string

 

-Corresponds to the teamd runner.agg_select_policy.
+ 
 
 
 
runner-fast-rate

 
boolean

 
FALSE

-Corresponds to the teamd runner.fast_rate.
+ 
 
 
 
runner-hwaddr-policy

 
string

 

-Corresponds to the teamd runner.hwaddr_policy.
+ 
 
 
 
runner-min-ports

 
int32

 
-1

-Corresponds to the teamd runner.min_ports.
+ 
 
 
 
runner-sys-prio

 
int32

 
-1

-Corresponds to the teamd runner.sys_prio.
+ 
 
 
 
runner-tx-balancer

 
string

 

-Corresponds to the teamd runner.tx_balancer.name.
+ 
 
 
 
runner-tx-balancer-interval

 
int32

 
-1

-Corresponds to the teamd runner.tx_balancer.interval.
+ 
 
 
 
runner-tx-hash

 
array of string

 

-Corresponds to the teamd runner.tx_hash.
+ 
 
 
 

diff --git a/docs/api/html/settings-tun.html b/docs/api/html/settings-tun.html
index f860607c..10fdbfb8 100644
--- a/docs/api/html/settings-tun.html
+++ b/docs/api/html/settings-tun.html
@@ -29,7 +29,7 @@
 

 
 
tun

-
tun — Tunnel Settings

+
tun —  Tunnel Settings

 		
 
 

@@ -57,37 +57,37 @@
 
group

 
string

 

-The group ID which will own the device. If set to NULL everyone will be able to use the device.
+ 
 
 
 
mode

 
uint32

 
1

-The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.
+ 
 
 
 
multi-queue

 
boolean

 
FALSE

-If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.
+ 
 
 
 
owner

 
string

 

-The user ID which will own the device. If set to NULL everyone will be able to use the device.
+ 
 
 
 
pi

 
boolean

 
FALSE

-If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.
+ 
 
 
 
vnet-hdr

 
boolean

 
FALSE

-If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.
+ 
 
 
 

diff --git a/docs/api/html/settings-user.html b/docs/api/html/settings-user.html
index 1c8e4626..66a8248d 100644
--- a/docs/api/html/settings-user.html
+++ b/docs/api/html/settings-user.html
@@ -29,7 +29,7 @@
 

 
 
user

-
user — General User Profile Settings

+
user —  General User Profile Settings

 		
 
 

@@ -56,7 +56,7 @@
 
data

 
dict of string to string

 
{}

-A dictionary of key/value pairs with user data. This data is ignored by NetworkManager and can be used at the users discretion. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length.
+ 
 
 

 

diff --git a/docs/api/html/settings-veth.html b/docs/api/html/settings-veth.html
index ea702cc6..4a8a8213 100644
--- a/docs/api/html/settings-veth.html
+++ b/docs/api/html/settings-veth.html
@@ -29,7 +29,7 @@
 

 
 
veth

-
veth — Veth Settings

+
veth —  Veth Settings

 		
 
 

@@ -56,7 +56,7 @@
 
peer

 
string

 

-This property specifies the peer interface name of the veth. This property is mandatory.
+ 
 
 

 

diff --git a/docs/api/html/settings-vlan.html b/docs/api/html/settings-vlan.html
index ef3df77d..2f10e0c2 100644
--- a/docs/api/html/settings-vlan.html
+++ b/docs/api/html/settings-vlan.html
@@ -29,7 +29,7 @@
 

 
 
vlan

-
vlan — VLAN Settings

+
vlan —  VLAN Settings

 		
 
 

@@ -57,37 +57,37 @@
 
egress-priority-map

 
array of string

 

-For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities.  The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".
+ 
 
 
 
flags

 
NMVlanFlags (uint32)

 

-One or more flags which control the behavior and features of the VLAN interface.  Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol). The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.
+ 
 
 
 
id

 
uint32

 
0

-The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.
+ 
 
 
 
ingress-priority-map

 
array of string

 

-For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities.  The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".
+ 
 
 
 
interface-name

 
string

 

-Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name.
+ 
 
 
 
parent

 
string

 

-If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created.  If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.
+ 
 
 
 

diff --git a/docs/api/html/settings-vpn.html b/docs/api/html/settings-vpn.html
index 9f8d5473..cdd8c3ad 100644
--- a/docs/api/html/settings-vpn.html
+++ b/docs/api/html/settings-vpn.html
@@ -29,7 +29,7 @@
 

 
 
vpn

-
vpn — VPN Settings

+
vpn —  VPN Settings

 		
 
 

@@ -57,37 +57,37 @@
 
data

 
dict of string to string

 
{}

-Dictionary of key/value pairs of VPN plugin specific data.  Both keys and values must be strings.
+ 
 
 
 
persistent

 
boolean

 
FALSE

-If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.
+ 
 
 
 
secrets

 
dict of string to string

 
{}

-Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys.  Both keys and values must be strings.
+ 
 
 
 
service-type

 
string

 

-D-Bus service name of the VPN plugin that this setting uses to connect to its network.  i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.
+ 
 
 
 
timeout

 
uint32

 
0

-Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overridden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.
+ 
 
 
 
user-name

 
string

 

-If the VPN connection requires a user name for authentication, that name should be provided here.  If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty.  If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.
+ 
 
 
 

diff --git a/docs/api/html/settings-vrf.html b/docs/api/html/settings-vrf.html
index 12ba3b34..f0472049 100644
--- a/docs/api/html/settings-vrf.html
+++ b/docs/api/html/settings-vrf.html
@@ -29,7 +29,7 @@
 

 
 
vrf

-
vrf — VRF settings

+
vrf —  VRF settings

 		
 
 

@@ -56,7 +56,7 @@
 
table

 
uint32

 
0

-The routing table for this VRF.
+ 
 
 

 

diff --git a/docs/api/html/settings-vxlan.html b/docs/api/html/settings-vxlan.html
index b497855d..c099f710 100644
--- a/docs/api/html/settings-vxlan.html
+++ b/docs/api/html/settings-vxlan.html
@@ -29,7 +29,7 @@
 

 
 
vxlan

-
vxlan — VXLAN Settings

+
vxlan —  VXLAN Settings

 		
 
 

@@ -57,97 +57,97 @@
 
ageing

 
uint32

 
300

-Specifies the lifetime in seconds of FDB entries learnt by the kernel.
+ 
 
 
 
destination-port

 
uint32

 
8472

-Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.
+ 
 
 
 
id

 
uint32

 
0

-Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.
+ 
 
 
 
l2-miss

 
boolean

 
FALSE

-Specifies whether netlink LL ADDR miss notifications are generated.
+ 
 
 
 
l3-miss

 
boolean

 
FALSE

-Specifies whether netlink IP ADDR miss notifications are generated.
+ 
 
 
 
learning

 
boolean

 
TRUE

-Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.
+ 
 
 
 
limit

 
uint32

 
0

-Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.
+ 
 
 
 
local

 
string

 

-If given, specifies the source IP address to use in outgoing packets.
+ 
 
 
 
parent

 
string

 

-If given, specifies the parent interface name or parent connection UUID.
+ 
 
 
 
proxy

 
boolean

 
FALSE

-Specifies whether ARP proxy is turned on.
+ 
 
 
 
remote

 
string

 

-Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.
+ 
 
 
 
rsc

 
boolean

 
FALSE

-Specifies whether route short circuit is turned on.
+ 
 
 
 
source-port-max

 
uint32

 
0

-Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.
+ 
 
 
 
source-port-min

 
uint32

 
0

-Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.
+ 
 
 
 
tos

 
uint32

 
0

-Specifies the TOS value to use in outgoing packets.
+ 
 
 
 
ttl

 
uint32

 
0

-Specifies the time-to-live value to use in outgoing packets.
+ 
 
 
 

diff --git a/docs/api/html/settings-wifi-p2p.html b/docs/api/html/settings-wifi-p2p.html
index 8328b1d8..cae67981 100644
--- a/docs/api/html/settings-wifi-p2p.html
+++ b/docs/api/html/settings-wifi-p2p.html
@@ -29,7 +29,7 @@
 

 
 
wifi-p2p

-
wifi-p2p — Wi-Fi P2P Settings

+
wifi-p2p —  Wi-Fi P2P Settings

 		
 
 

@@ -57,19 +57,19 @@
 
peer

 
string

 

-The P2P device that should be connected to. Currently, this is the only way to create or join a group.
+ 
 
 
 
wfd-ies

 
byte array

 

-The Wi-Fi Display (WFD) Information Elements (IEs) to set. Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.
+ 
 
 
 
wps-method

 
uint32

 
0

-Flags indicating which mode of WPS is to be used. There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.
+ 
 
 
 
diff --git a/docs/api/html/settings-wimax.html b/docs/api/html/settings-wimax.html
index 919bfe4e..d4748205 100644
--- a/docs/api/html/settings-wimax.html
+++ b/docs/api/html/settings-wimax.html
@@ -29,7 +29,7 @@
 

 
 
wimax

-
wimax — WiMax Settings

+
wimax —  WiMax Settings

 		
 
 

@@ -57,13 +57,13 @@
 
mac-address

 
byte array

 

-If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing). Deprecated: 1
+ 
 
 
 
network-name

 
string

 

-Network Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1
+ 
 
 
 
diff --git a/docs/api/html/settings-wireguard.html b/docs/api/html/settings-wireguard.html
index 850c85ab..88dc36c2 100644
--- a/docs/api/html/settings-wireguard.html
+++ b/docs/api/html/settings-wireguard.html
@@ -29,7 +29,7 @@
 

 
 
wireguard

-
wireguard — WireGuard Settings

+
wireguard —  WireGuard Settings

 		
 
 

@@ -57,55 +57,55 @@
 
fwmark

 
uint32

 
0

-The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets. Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.
+ 
 
 
 
ip4-auto-default-route

 
NMTernary (int32)

 

-Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing". Note that for this automatism to work, you usually don't want to set ipv4.gateway, because that will result in a conflicting default route. Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips.
+ 
 
 
 
ip6-auto-default-route

 
NMTernary (int32)

 

-Like ip4-auto-default-route, but for the IPv6 default route.
+ 
 
 
 
listen-port

 
uint32

 
0

-The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.
+ 
 
 
 
mtu

 
uint32

 
0

-If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments. If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation.
+ 
 
 
 
peer-routes

 
boolean

 
TRUE

-Whether to automatically add routes for the AllowedIPs ranges of the peers. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If FALSE, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively. Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically.
+ 
 
 
 
peers

 
array of 'a{sv}'

 

-Array of dictionaries for the WireGuard peers.
+ 
 
 
 
private-key

 
string

 

-The 256 bit private-key in base64 encoding.
+ 
 
 
 
private-key-flags

 
NMSettingSecretFlags (uint32)

 

-Flags indicating how to handle the "private-key" property.
+ 
 
 
 
diff --git a/docs/api/html/settings-wpan.html b/docs/api/html/settings-wpan.html
index 474d1155..83aeb13f 100644
--- a/docs/api/html/settings-wpan.html
+++ b/docs/api/html/settings-wpan.html
@@ -29,7 +29,7 @@
 

 
 
wpan

-
wpan — IEEE 802.15.4 (WPAN) MAC Settings

+
wpan —  IEEE 802.15.4 (WPAN) MAC Settings

 		
 
 

@@ -57,31 +57,31 @@
 
channel

 
int32

 
-1

-IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".
+ 
 
 
 
mac-address

 
string

 

-If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.
+ 
 
 
 
page

 
int32

 
-1

-IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".
+ 
 
 
 
pan-id

 
uint32

 
65535

-IEEE 802.15.4 Personal Area Network (PAN) identifier.
+ 
 
 
 
short-address

 
uint32

 
65535

-Short IEEE 802.15.4 address to be used within a restricted environment.
+ 
 
 
 
-- 
cgit 1.3.0-6-gf8a5


From ab0efddcdb48d800e2f938da54cfe3074640792e Mon Sep 17 00:00:00 2001
From: Michael Biebl 
Date: Fri, 26 Aug 2022 20:36:29 +0200
Subject: New upstream version 1.40.0

---
 docs/api/html/NetworkManager.conf.html |  2 +-
 docs/api/html/NetworkManager.devhelp2  | 13 +++++++------
 docs/api/html/index.html               |  2 +-
 docs/api/html/nm-dbus-types.html       | 23 +++++++++++++++++++----
 docs/api/html/nm-settings-dbus.html    | 18 ++++++++++--------
 docs/api/html/nm-settings-nmcli.html   | 17 +++++++++--------
 6 files changed, 47 insertions(+), 28 deletions(-)

(limited to 'docs/api/html')

diff --git a/docs/api/html/NetworkManager.conf.html b/docs/api/html/NetworkManager.conf.html
index e2bd8c54..34063973 100644
--- a/docs/api/html/NetworkManager.conf.html
+++ b/docs/api/html/NetworkManager.conf.html
@@ -818,7 +818,7 @@ ipv6.ip6-privacy=0
 
 
 
connection.mptcp-flags

-
If unspecified, the fallback is either 0 ("disabled") or 0x22 ("enabled-on-global-iface,subflow"), depending on /proc/sys/net/mptcp/enabled.

+
If unspecified, the fallback is 0x22 ("enabled,subflow"). Note that if sysctl /proc/sys/net/mptcp/enabled is disabled, NetworkManager will still not configure endpoints.

 
 
 
connection.dns-over-tls

diff --git a/docs/api/html/NetworkManager.devhelp2 b/docs/api/html/NetworkManager.devhelp2
index 7fd00dea..257f6bde 100644
--- a/docs/api/html/NetworkManager.devhelp2
+++ b/docs/api/html/NetworkManager.devhelp2
@@ -852,12 +852,13 @@
     
     
     
-    
-    
-    
-    
-    
-    
+    
+    
+    
+    
+    
+    
+    
     
     
     
diff --git a/docs/api/html/index.html b/docs/api/html/index.html
index 89e8f738..e753eef1 100644
--- a/docs/api/html/index.html
+++ b/docs/api/html/index.html
@@ -16,7 +16,7 @@
 

 

 

-      for NetworkManager 1.39.90
+      for NetworkManager 1.40.0
 
       The latest version of this documentation can be found on-line at
       https://networkmanager.dev/docs/api/latest/.
diff --git a/docs/api/html/nm-dbus-types.html b/docs/api/html/nm-dbus-types.html
index 9935f48c..46152667 100644
--- a/docs/api/html/nm-dbus-types.html
+++ b/docs/api/html/nm-dbus-types.html
@@ -5366,7 +5366,7 @@
 
 
 
-
NM_MPTCP_FLAGS_ENABLED_ON_GLOBAL_IFACE

+
NM_MPTCP_FLAGS_ENABLED

 

 
 
@@ -5374,14 +5374,14 @@
 

 
 
-
MPTCP handling is enabled or disabled depending on whether a /0 default route (either IPv4 or IPv6) is configured in the main routing table.

+
MPTCP is enabled and endpoints will be configured. This flag is implied if any of the other flags indicate that MPTCP is enabled and therefore in most cases unnecessary. Note that if "/proc/sys/net/mptcp/enabled" sysctl is disabled, MPTCP handling is disabled despite this flag. This can be overruled with the "also-without-sysctl" flag. Note that by default interfaces that don't have a default route are excluded from having MPTCP endpoints configured. This can be overruled with the "also-without-default-route" and this affects endpoints per address family.

 

 
  
 
 
 
-
NM_MPTCP_FLAGS_ENABLED

+
NM_MPTCP_FLAGS_ALSO_WITHOUT_SYSCTL

 

 
 
@@ -5389,7 +5389,22 @@
 

 
 
-
MPTCP is enabled and endpoints will be configured. This flag is implied if any of the other flags indicate that MPTCP is enabled and therefore in most cases unnecessary.

+
even if MPTCP handling is enabled via the "enabled" flag, it is ignored unless "/proc/sys/net/mptcp/enabled" is on. With this flag, MPTCP endpoints will be configured regardless of the sysctl setting.

+

+
+ 
+
+
+
+
NM_MPTCP_FLAGS_ALSO_WITHOUT_DEFAULT_ROUTE

+

+
+
+
= 0x8

+

+
+
+
even if MPTCP handling is enabled via the "enabled" flag, it is ignored per-address family unless NetworkManager configures a default route. With this flag, NetworkManager will also configure MPTCP endpoints if there is no default route. This takes effect per-address family.

 

 
  
diff --git a/docs/api/html/nm-settings-dbus.html b/docs/api/html/nm-settings-dbus.html
index f0aed252..0903c329 100644
--- a/docs/api/html/nm-settings-dbus.html
+++ b/docs/api/html/nm-settings-dbus.html
@@ -245,13 +245,15 @@
 
  If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered.
 
- The flag "enabled-on-global-iface" (0x2) means that MPTCP handling is enabled if the interface configures a default route in the main routing table. This choice is per-address family, for example if there is an IPv4 default route 0.0.0.0/0, IPv4 endpoints are configured.
+ The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags.
 
- The "enabled" (0x4) flag means that MPTCP handling is explicitly enabled. This flag can also be implied from the presence of other flags.
+ Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless.
 
- If MPTCP handling is enabled, then endpoints will be configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags.
+ Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that.
 
- If the flags are zero, the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is either "disabled" or "enabled-on-global-iface,subflow" depending on "/proc/sys/net/mptcp/enabled".
+ When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags.
+
+ If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl.
 
  NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp.
 
@@ -1805,9 +1807,9 @@
  
  The gateway associated with this configuration. This is only meaningful if "addresses" is also set.
 
- The gateway's main purpose is to control the next hop of the standard default route on the device. Hence, the gateway property conflicts with "never-default" and will be automatically dropped if the IP configuration is set to never-default.
+ Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.
 
- As an alternative to set the gateway, configure a static default route with /0 as prefix length.
+ Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".
 
 
 
@@ -2099,9 +2101,9 @@
  
  The gateway associated with this configuration. This is only meaningful if "addresses" is also set.
 
- The gateway's main purpose is to control the next hop of the standard default route on the device. Hence, the gateway property conflicts with "never-default" and will be automatically dropped if the IP configuration is set to never-default.
+ Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.
 
- As an alternative to set the gateway, configure a static default route with /0 as prefix length.
+ Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".
 
 
 
diff --git a/docs/api/html/nm-settings-nmcli.html b/docs/api/html/nm-settings-nmcli.html
index 672f9e43..6968e035 100644
--- a/docs/api/html/nm-settings-nmcli.html
+++ b/docs/api/html/nm-settings-nmcli.html
@@ -217,10 +217,11 @@
 
 
 Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints.

 
 If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered.

-
 The flag "enabled-on-global-iface" (0x2) means that MPTCP handling is enabled if the interface configures a default route in the main routing table. This choice is per-address family, for example if there is an IPv4 default route 0.0.0.0/0, IPv4 endpoints are configured.

-
 The "enabled" (0x4) flag means that MPTCP handling is explicitly enabled. This flag can also be implied from the presence of other flags.

-
 If MPTCP handling is enabled, then endpoints will be configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags.

-
 If the flags are zero, the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is either "disabled" or "enabled-on-global-iface,subflow" depending on "/proc/sys/net/mptcp/enabled".

+
 The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags.

+
 Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless.

+
 Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that.

+
 When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags.

+
 If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl.

 
 NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp.

 
 Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).

 

@@ -2156,8 +2157,8 @@
 

             Alias: gw4

 
 The gateway associated with this configuration. This is only meaningful if "addresses" is also set.

-
 The gateway's main purpose is to control the next hop of the standard default route on the device. Hence, the gateway property conflicts with "never-default" and will be automatically dropped if the IP configuration is set to never-default.

-
 As an alternative to set the gateway, configure a static default route with /0 as prefix length.

+
 Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.

+
 Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".

 

             Format: string

 
@@ -2453,8 +2454,8 @@ Example: priority 5 from 192.167.4.0/24 table 45
 

             Alias: gw6

 
 The gateway associated with this configuration. This is only meaningful if "addresses" is also set.

-
 The gateway's main purpose is to control the next hop of the standard default route on the device. Hence, the gateway property conflicts with "never-default" and will be automatically dropped if the IP configuration is set to never-default.

-
 As an alternative to set the gateway, configure a static default route with /0 as prefix length.

+
 Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.

+
 Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".

 

             Format: string

 
-- 
cgit 1.3.0-6-gf8a5