From 6accbd3ec0e42d8633bbde4d47ed7bfe854e7e0b Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 12 Aug 2022 19:21:11 +0200 Subject: New upstream version 1.38.4 --- docs/api/Makefile.in | 10 +- ...-org.freedesktop.NetworkManager.AccessPoint.xml | 56 ++- ...org.freedesktop.NetworkManager.AgentManager.xml | 31 +- ...reedesktop.NetworkManager.Connection.Active.xml | 126 +++-- ...-org.freedesktop.NetworkManager.DHCP4Config.xml | 6 +- ...-org.freedesktop.NetworkManager.DHCP6Config.xml | 6 +- ...-org.freedesktop.NetworkManager.Device.Adsl.xml | 12 +- ...freedesktop.NetworkManager.Device.Bluetooth.xml | 19 +- ...-org.freedesktop.NetworkManager.Device.Bond.xml | 26 +- ...rg.freedesktop.NetworkManager.Device.Bridge.xml | 26 +- ...org.freedesktop.NetworkManager.Device.Dummy.xml | 9 +- ...g.freedesktop.NetworkManager.Device.Generic.xml | 12 +- ....freedesktop.NetworkManager.Device.IPTunnel.xml | 48 +- ...reedesktop.NetworkManager.Device.Infiniband.xml | 19 +- ...rg.freedesktop.NetworkManager.Device.Macsec.xml | 55 +- ...g.freedesktop.NetworkManager.Device.Macvlan.xml | 16 +- ...org.freedesktop.NetworkManager.Device.Modem.xml | 39 +- ....freedesktop.NetworkManager.Device.OlpcMesh.xml | 16 +- ...reedesktop.NetworkManager.Device.Statistics.xml | 19 +- ...-org.freedesktop.NetworkManager.Device.Team.xml | 29 +- ...s-org.freedesktop.NetworkManager.Device.Tun.xml | 33 +- ...-org.freedesktop.NetworkManager.Device.Veth.xml | 7 +- ...-org.freedesktop.NetworkManager.Device.Vlan.xml | 25 +- ...org.freedesktop.NetworkManager.Device.Vxlan.xml | 71 ++- ...g.freedesktop.NetworkManager.Device.WifiP2P.xml | 55 +- ...freedesktop.NetworkManager.Device.WireGuard.xml | 15 +- ...org.freedesktop.NetworkManager.Device.Wired.xml | 29 +- ....freedesktop.NetworkManager.Device.Wireless.xml | 84 ++-- .../dbus-org.freedesktop.NetworkManager.Device.xml | 361 ++++++++------ ...s-org.freedesktop.NetworkManager.DnsManager.xml | 24 +- ...us-org.freedesktop.NetworkManager.IP4Config.xml | 69 ++- ...us-org.freedesktop.NetworkManager.IP6Config.xml | 46 +- .../dbus-org.freedesktop.NetworkManager.PPP.xml | 48 +- ...-org.freedesktop.NetworkManager.SecretAgent.xml | 95 ++-- ...edesktop.NetworkManager.Settings.Connection.xml | 249 +++++---- ...bus-org.freedesktop.NetworkManager.Settings.xml | 251 ++++++---- ...g.freedesktop.NetworkManager.VPN.Connection.xml | 23 +- ...s-org.freedesktop.NetworkManager.VPN.Plugin.xml | 145 ++++-- docs/api/dbus-org.freedesktop.NetworkManager.xml | 553 ++++++++++++-------- docs/api/html/NetworkManager-dispatcher.html | 4 +- .../html/NetworkManager-wait-online.service.html | 4 +- docs/api/html/NetworkManager.conf.html | 4 +- docs/api/html/NetworkManager.html | 4 +- docs/api/html/ch01.html | 4 +- docs/api/html/dbus-secret-agent.html | 4 +- docs/api/html/dbus-types.html | 4 +- docs/api/html/dbus-vpn-plugin.html | 4 +- docs/api/html/dbus-vpn-types.html | 4 +- ...org.freedesktop.NetworkManager.AccessPoint.html | 61 ++- ...rg.freedesktop.NetworkManager.AgentManager.html | 36 +- ...-org.freedesktop.NetworkManager.Checkpoint.html | 18 +- ...eedesktop.NetworkManager.Connection.Active.html | 130 +++-- ...org.freedesktop.NetworkManager.DHCP4Config.html | 10 +- ...org.freedesktop.NetworkManager.DHCP6Config.html | 10 +- ...org.freedesktop.NetworkManager.Device.Adsl.html | 17 +- ...reedesktop.NetworkManager.Device.Bluetooth.html | 24 +- ...org.freedesktop.NetworkManager.Device.Bond.html | 31 +- ...g.freedesktop.NetworkManager.Device.Bridge.html | 31 +- ...rg.freedesktop.NetworkManager.Device.Dummy.html | 14 +- ....freedesktop.NetworkManager.Device.Generic.html | 17 +- ...freedesktop.NetworkManager.Device.IPTunnel.html | 53 +- ...eedesktop.NetworkManager.Device.Infiniband.html | 24 +- ...g.freedesktop.NetworkManager.Device.Lowpan.html | 18 +- ...g.freedesktop.NetworkManager.Device.Macsec.html | 60 ++- ....freedesktop.NetworkManager.Device.Macvlan.html | 21 +- ...rg.freedesktop.NetworkManager.Device.Modem.html | 44 +- ...freedesktop.NetworkManager.Device.OlpcMesh.html | 21 +- ...reedesktop.NetworkManager.Device.OvsBridge.html | 16 +- ...desktop.NetworkManager.Device.OvsInterface.html | 9 +- ....freedesktop.NetworkManager.Device.OvsPort.html | 16 +- ...-org.freedesktop.NetworkManager.Device.Ppp.html | 9 +- ...eedesktop.NetworkManager.Device.Statistics.html | 24 +- ...org.freedesktop.NetworkManager.Device.Team.html | 34 +- ...-org.freedesktop.NetworkManager.Device.Tun.html | 38 +- ...org.freedesktop.NetworkManager.Device.Veth.html | 12 +- ...org.freedesktop.NetworkManager.Device.Vlan.html | 30 +- ...-org.freedesktop.NetworkManager.Device.Vrf.html | 12 +- ...rg.freedesktop.NetworkManager.Device.Vxlan.html | 76 +-- ....freedesktop.NetworkManager.Device.WifiP2P.html | 48 +- ...reedesktop.NetworkManager.Device.WireGuard.html | 20 +- ...rg.freedesktop.NetworkManager.Device.Wired.html | 34 +- ...freedesktop.NetworkManager.Device.Wireless.html | 89 ++-- ...org.freedesktop.NetworkManager.Device.Wpan.html | 15 +- ...dbus-org.freedesktop.NetworkManager.Device.html | 367 ++++++++------ ...-org.freedesktop.NetworkManager.DnsManager.html | 28 +- ...s-org.freedesktop.NetworkManager.IP4Config.html | 74 +-- ...s-org.freedesktop.NetworkManager.IP6Config.html | 51 +- .../gdbus-org.freedesktop.NetworkManager.PPP.html | 76 ++- ...org.freedesktop.NetworkManager.SecretAgent.html | 99 ++-- ...desktop.NetworkManager.Settings.Connection.html | 185 ++++--- ...us-org.freedesktop.NetworkManager.Settings.html | 217 +++++--- ....freedesktop.NetworkManager.VPN.Connection.html | 27 +- ...-org.freedesktop.NetworkManager.VPN.Plugin.html | 149 ++++-- ...org.freedesktop.NetworkManager.WifiP2PPeer.html | 46 +- .../html/gdbus-org.freedesktop.NetworkManager.html | 554 +++++++++++++-------- docs/api/html/index.html | 6 +- docs/api/html/ix01.html | 4 +- docs/api/html/license.html | 4 +- docs/api/html/manpages.html | 4 +- docs/api/html/nm-cloud-setup.html | 4 +- docs/api/html/nm-dbus-types.html | 6 +- docs/api/html/nm-initrd-generator.html | 4 +- docs/api/html/nm-online.html | 4 +- docs/api/html/nm-openvswitch.html | 4 +- docs/api/html/nm-settings-dbus.html | 4 +- docs/api/html/nm-settings-ifcfg-rh.html | 4 +- docs/api/html/nm-settings-keyfile.html | 4 +- docs/api/html/nm-settings-nmcli.html | 4 +- docs/api/html/nm-vpn-dbus-types.html | 4 +- docs/api/html/nmcli-examples.html | 4 +- docs/api/html/nmcli.html | 4 +- docs/api/html/nmtui.html | 4 +- docs/api/html/ref-dbus-access-points.html | 4 +- docs/api/html/ref-dbus-active-connections.html | 4 +- docs/api/html/ref-dbus-agent-manager.html | 4 +- docs/api/html/ref-dbus-checkpoint.html | 4 +- docs/api/html/ref-dbus-devices.html | 4 +- docs/api/html/ref-dbus-dhcp4-configs.html | 4 +- docs/api/html/ref-dbus-dhcp6-configs.html | 4 +- docs/api/html/ref-dbus-dns-manager.html | 4 +- docs/api/html/ref-dbus-ip4-configs.html | 4 +- docs/api/html/ref-dbus-ip6-configs.html | 4 +- docs/api/html/ref-dbus-manager.html | 4 +- docs/api/html/ref-dbus-settings-manager.html | 4 +- docs/api/html/ref-dbus-settings.html | 4 +- docs/api/html/ref-dbus-wifi-p2p-peers.html | 4 +- docs/api/html/ref-settings.html | 4 +- docs/api/html/secret-agents.html | 4 +- docs/api/html/secrets-flags.html | 4 +- docs/api/html/settings-6lowpan.html | 4 +- docs/api/html/settings-802-11-olpc-mesh.html | 4 +- .../html/settings-802-11-wireless-security.html | 4 +- docs/api/html/settings-802-11-wireless.html | 4 +- docs/api/html/settings-802-1x.html | 4 +- docs/api/html/settings-802-3-ethernet.html | 4 +- docs/api/html/settings-adsl.html | 4 +- docs/api/html/settings-bluetooth.html | 4 +- docs/api/html/settings-bond-port.html | 4 +- docs/api/html/settings-bond.html | 4 +- docs/api/html/settings-bridge-port.html | 4 +- docs/api/html/settings-bridge.html | 4 +- docs/api/html/settings-cdma.html | 4 +- docs/api/html/settings-connection.html | 4 +- docs/api/html/settings-dcb.html | 4 +- docs/api/html/settings-dummy.html | 4 +- docs/api/html/settings-ethtool.html | 4 +- docs/api/html/settings-generic.html | 4 +- docs/api/html/settings-gsm.html | 4 +- docs/api/html/settings-hostname.html | 4 +- docs/api/html/settings-infiniband.html | 4 +- docs/api/html/settings-ip-tunnel.html | 4 +- docs/api/html/settings-ipv4.html | 4 +- docs/api/html/settings-ipv6.html | 4 +- docs/api/html/settings-macsec.html | 4 +- docs/api/html/settings-macvlan.html | 4 +- docs/api/html/settings-match.html | 4 +- docs/api/html/settings-ovs-bridge.html | 4 +- docs/api/html/settings-ovs-dpdk.html | 4 +- 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 | 4 +- docs/api/html/settings-ppp.html | 4 +- docs/api/html/settings-pppoe.html | 4 +- docs/api/html/settings-proxy.html | 4 +- docs/api/html/settings-serial.html | 4 +- docs/api/html/settings-sriov.html | 4 +- docs/api/html/settings-tc.html | 4 +- docs/api/html/settings-team-port.html | 4 +- docs/api/html/settings-team.html | 4 +- docs/api/html/settings-tun.html | 4 +- docs/api/html/settings-user.html | 4 +- docs/api/html/settings-veth.html | 4 +- docs/api/html/settings-vlan.html | 4 +- docs/api/html/settings-vpn.html | 4 +- docs/api/html/settings-vrf.html | 4 +- docs/api/html/settings-vxlan.html | 4 +- docs/api/html/settings-wifi-p2p.html | 4 +- docs/api/html/settings-wimax.html | 4 +- docs/api/html/settings-wireguard.html | 4 +- docs/api/html/settings-wpan.html | 4 +- docs/api/html/spec.html | 4 +- docs/api/html/style.css | 34 +- docs/api/html/vpn-plugins.html | 4 +- docs/api/version.xml | 2 +- 185 files changed, 3858 insertions(+), 2328 deletions(-) (limited to 'docs/api') diff --git a/docs/api/Makefile.in b/docs/api/Makefile.in index b5e385ea..b24b8b6b 100644 --- a/docs/api/Makefile.in +++ b/docs/api/Makefile.in @@ -1,7 +1,7 @@ -# Makefile.in generated by automake 1.16.2 from Makefile.am. +# Makefile.in generated by automake 1.16.5 from Makefile.am. # @configure_input@ -# Copyright (C) 1994-2020 Free Software Foundation, Inc. +# Copyright (C) 1994-2021 Free Software Foundation, Inc. # This Makefile.in is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, @@ -184,6 +184,8 @@ CODE_COVERAGE_ENABLED = @CODE_COVERAGE_ENABLED@ CODE_COVERAGE_LDFLAGS = @CODE_COVERAGE_LDFLAGS@ CPP = @CPP@ CPPFLAGS = @CPPFLAGS@ +CSCOPE = @CSCOPE@ +CTAGS = @CTAGS@ CXX = @CXX@ CXXCPP = @CXXCPP@ CXXDEPMODE = @CXXDEPMODE@ @@ -205,8 +207,10 @@ ECHO_T = @ECHO_T@ EGREP = @EGREP@ ELOGIND_INHIBIT_CFLAGS = @ELOGIND_INHIBIT_CFLAGS@ ELOGIND_INHIBIT_LIBS = @ELOGIND_INHIBIT_LIBS@ +ETAGS = @ETAGS@ EXEEXT = @EXEEXT@ FGREP = @FGREP@ +FILECMD = @FILECMD@ GENHTML = @GENHTML@ GETTEXT_MACRO_VERSION = @GETTEXT_MACRO_VERSION@ GETTEXT_PACKAGE = @GETTEXT_PACKAGE@ @@ -567,6 +571,7 @@ DOC_STAMPS = setup-build.stamp scan-build.stamp sgml-build.stamp \ sgml.stamp html.stamp pdf.stamp SCANOBJ_FILES = \ + $(DOC_MODULE).actions \ $(DOC_MODULE).args \ $(DOC_MODULE).hierarchy \ $(DOC_MODULE).interfaces \ @@ -664,7 +669,6 @@ ctags CTAGS: cscope cscopelist: - distdir: $(BUILT_SOURCES) $(MAKE) $(AM_MAKEFLAGS) distdir-am diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.AccessPoint.xml b/docs/api/dbus-org.freedesktop.NetworkManager.AccessPoint.xml index a3e0d61c..c649b74a 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.AccessPoint.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.AccessPoint.xml @@ -22,7 +22,9 @@ Description - + + + Property Details @@ -32,8 +34,10 @@ Flags readable u - Flags describing the capabilities of the access point. - Returns: NM80211ApFlags + +Flags describing the capabilities of the access point. + +Returns: NM80211ApFlags @@ -42,9 +46,11 @@ Flags readable u WpaFlags readable u - Flags describing the access point's capabilities according to WPA (Wifi - Protected Access). - Returns: NM80211ApSecurityFlags + +Flags describing the access point's capabilities according to WPA (Wifi +Protected Access). + +Returns: NM80211ApSecurityFlags @@ -53,9 +59,11 @@ WpaFlags readable u RsnFlags readable u - Flags describing the access point's capabilities according to the RSN - (Robust Secure Network) protocol. - Returns: NM80211ApSecurityFlags + +Flags describing the access point's capabilities according to the RSN +(Robust Secure Network) protocol. + +Returns: NM80211ApSecurityFlags @@ -64,7 +72,8 @@ RsnFlags readable u Ssid readable ay - The Service Set Identifier identifying the access point. + +The Service Set Identifier identifying the access point. @@ -73,7 +82,8 @@ Ssid readable ay Frequency readable u - The radio channel frequency in use by the access point, in MHz. + +The radio channel frequency in use by the access point, in MHz. @@ -82,7 +92,8 @@ Frequency readable u HwAddress readable s - The hardware address (BSSID) of the access point. + +The hardware address (BSSID) of the access point. @@ -91,8 +102,10 @@ HwAddress readable s Mode readable u - Describes the operating mode of the access point. - Returns: NM80211Mode + +Describes the operating mode of the access point. + +Returns: NM80211Mode @@ -101,8 +114,9 @@ Mode readable u MaxBitrate readable u - The maximum bitrate this access point is capable of, in kilobits/second - (Kb/s). + +The maximum bitrate this access point is capable of, in kilobits/second +(Kb/s). @@ -111,7 +125,8 @@ MaxBitrate readable u Strength readable y - The current signal quality of the access point, in percent. + +The current signal quality of the access point, in percent. @@ -120,9 +135,10 @@ Strength readable y LastSeen readable i - The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access - point was found in scan results. A value of -1 means the access point has - never been found in scan results. + +The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access +point was found in scan results. A value of -1 means the access point has +never been found in scan results. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.AgentManager.xml b/docs/api/dbus-org.freedesktop.NetworkManager.AgentManager.xml index b6a73b6a..7a9b048d 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.AgentManager.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.AgentManager.xml @@ -16,7 +16,9 @@ Description - + + + Method Details @@ -26,13 +28,16 @@ Register (IN s identifier); - Called by secret Agents to register their ability to provide and save - network secrets. + +Called by secret Agents to register their ability to provide and save +network secrets. IN s identifier: - Identifies this agent; only one agent in each user session may use the same identifier. Identifier formatting follows the same rules as D-Bus bus names with the exception that the ':' character is not allowed. The valid set of characters is "[A-Z][a-z][0-9]_-." and the identifier is limited in length to 255 characters with a minimum of 3 characters. An example valid identifier is 'org.gnome.nm-applet' (without quotes). + +Identifies this agent; only one agent in each user session may use the same identifier. Identifier formatting follows the same rules as D-Bus bus names with the exception that the ':' character is not allowed. The valid set of characters is "[A-Z][a-z][0-9]_-." and the identifier is limited in length to 255 characters with a minimum of 3 characters. An example valid identifier is 'org.gnome.nm-applet' (without quotes). + @@ -43,16 +48,21 @@ Register (IN s identifier); RegisterWithCapabilities (IN s identifier, IN u capabilities); - Like Register() but indicates agent capabilities to NetworkManager. + +Like Register() but indicates agent capabilities to NetworkManager. IN s identifier: - See the Register() method's identifier argument. + +See the Register() method's identifier argument. + IN u capabilities: - (NMSecretAgentCapabilities) Indicates various agent capabilities to NetworkManager. + +(NMSecretAgentCapabilities) Indicates various agent capabilities to NetworkManager. + @@ -62,9 +72,10 @@ RegisterWithCapabilities (IN s identifier, Unregister (); - Called by secret Agents to notify NetworkManager that they will no longer - handle requests for network secrets. Agents are automatically unregistered - when they disconnect from D-Bus. + +Called by secret Agents to notify NetworkManager that they will no longer +handle requests for network secrets. Agents are automatically unregistered +when they disconnect from D-Bus. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Connection.Active.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Connection.Active.xml index d083906a..00f2a708 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Connection.Active.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Connection.Active.xml @@ -35,20 +35,21 @@ Description - Objects that implement the Connection.Active interface represent an - attempt to connect to a network using the details provided by a Connection - object. The Connection.Active object tracks the life-cycle of the - connection attempt and if successful indicates whether the connected - network is the "default" or preferred network for access. NetworkManager - has the concept of connections, which can be thought of as settings, a - profile or a configuration that can be applied on a networking device. - Such settings-connections are exposed as D-Bus object and the - active-connection expresses this relationship between device and - settings-connection. At any time a settings-connection can only be - activated on one device and vice versa. However, during activation and - deactivation multiple active-connections can reference the same device or - settings-connection as they are waiting to be activated or to be - deactivated. + +Objects that implement the Connection.Active interface represent an +attempt to connect to a network using the details provided by a Connection +object. The Connection.Active object tracks the life-cycle of the +connection attempt and if successful indicates whether the connected +network is the "default" or preferred network for access. NetworkManager +has the concept of connections, which can be thought of as settings, a +profile or a configuration that can be applied on a networking device. +Such settings-connections are exposed as D-Bus object and the +active-connection expresses this relationship between device and +settings-connection. At any time a settings-connection can only be +activated on one device and vice versa. However, during activation and +deactivation multiple active-connections can reference the same device or +settings-connection as they are waiting to be activated or to be +deactivated. @@ -60,16 +61,21 @@ StateChanged (u state, u reason); - Emitted when the state of the active connection has changed. + +Emitted when the state of the active connection has changed. u state: - (NMActiveConnectionState) The new state of the active connection. + +(NMActiveConnectionState) The new state of the active connection. + u reason: - (NMActiveConnectionStateReason) Reason code describing the change to the new state. + +(NMActiveConnectionStateReason) Reason code describing the change to the new state. + Since 1.8 @@ -83,7 +89,8 @@ StateChanged (u state, Connection readable o - The path of the connection. + +The path of the connection. @@ -92,9 +99,10 @@ Connection readable o SpecificObject readable o - A specific object associated with the active connection. This property - reflects the specific object used during connection activation, and will - not change over the lifetime of the ActiveConnection once set. + +A specific object associated with the active connection. This property +reflects the specific object used during connection activation, and will +not change over the lifetime of the ActiveConnection once set. @@ -103,8 +111,9 @@ SpecificObject readable o Id readable s - The ID of the connection, provided as a convenience so that clients do not - have to retrieve all connection details. + +The ID of the connection, provided as a convenience so that clients do not +have to retrieve all connection details. @@ -113,8 +122,9 @@ Id readable s Uuid readable s - The UUID of the connection, provided as a convenience so that clients do - not have to retrieve all connection details. + +The UUID of the connection, provided as a convenience so that clients do +not have to retrieve all connection details. @@ -123,8 +133,9 @@ Uuid readable s Type readable s - The type of the connection, provided as a convenience so that clients do - not have to retrieve all connection details. + +The type of the connection, provided as a convenience so that clients do +not have to retrieve all connection details. @@ -133,8 +144,9 @@ Type readable s Devices readable ao - Array of object paths representing devices which are part of this active - connection. + +Array of object paths representing devices which are part of this active +connection. @@ -143,8 +155,10 @@ Devices readable ao State readable u - The state of this active connection. - Returns: NMActiveConnectionState + +The state of this active connection. + +Returns: NMActiveConnectionState @@ -153,8 +167,10 @@ State readable u StateFlags readable u - The state flags of this active connection. - Returns: NMActivationStateFlags + +The state flags of this active connection. + +Returns: NMActivationStateFlags @@ -163,8 +179,9 @@ StateFlags readable u Default readable b - Whether this active connection is the default IPv4 connection, i.e. - whether it currently owns the default IPv4 route. + +Whether this active connection is the default IPv4 connection, i.e. +whether it currently owns the default IPv4 route. @@ -173,9 +190,10 @@ Default readable b Ip4Config readable o - Object path of the Ip4Config object describing the configuration of the - connection. Only valid when the connection is in the - NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. + +Object path of the Ip4Config object describing the configuration of the +connection. Only valid when the connection is in the +NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. @@ -184,9 +202,10 @@ Ip4Config readable o Dhcp4Config readable o - Object path of the Dhcp4Config object describing the DHCP options returned - by the DHCP server (assuming the connection used DHCP). Only valid when - the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. + +Object path of the Dhcp4Config object describing the DHCP options returned +by the DHCP server (assuming the connection used DHCP). Only valid when +the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. @@ -195,8 +214,9 @@ Dhcp4Config readable o Default6 readable b - Whether this active connection is the default IPv6 connection, i.e. - whether it currently owns the default IPv6 route. + +Whether this active connection is the default IPv6 connection, i.e. +whether it currently owns the default IPv6 route. @@ -205,9 +225,10 @@ Default6 readable b Ip6Config readable o - Object path of the Ip6Config object describing the configuration of the - connection. Only valid when the connection is in the - NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. + +Object path of the Ip6Config object describing the configuration of the +connection. Only valid when the connection is in the +NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. @@ -216,9 +237,10 @@ Ip6Config readable o Dhcp6Config readable o - Object path of the Dhcp6Config object describing the DHCP options returned - by the DHCP server (assuming the connection used DHCP). Only valid when - the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. + +Object path of the Dhcp6Config object describing the DHCP options returned +by the DHCP server (assuming the connection used DHCP). Only valid when +the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. @@ -227,7 +249,8 @@ Dhcp6Config readable o Vpn readable b - Whether this active connection is also a VPN connection. + +Whether this active connection is also a VPN connection. @@ -236,7 +259,8 @@ Vpn readable b Master readable o - The path to the master device if the connection is a slave. + +The path to the master device if the connection is a slave. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.DHCP4Config.xml b/docs/api/dbus-org.freedesktop.NetworkManager.DHCP4Config.xml index 957ed31b..6b879a0a 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.DHCP4Config.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.DHCP4Config.xml @@ -13,7 +13,8 @@ Description - Options and configuration returned by the IPv4 DHCP server. + +Options and configuration returned by the IPv4 DHCP server. @@ -24,7 +25,8 @@ Options readable a{sv} - Configuration options returned by a DHCP server, if any. + +Configuration options returned by a DHCP server, if any. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.DHCP6Config.xml b/docs/api/dbus-org.freedesktop.NetworkManager.DHCP6Config.xml index 292abdcd..9a82ff45 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.DHCP6Config.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.DHCP6Config.xml @@ -13,7 +13,8 @@ Description - Options and configuration returned by the IPv6 DHCP server. + +Options and configuration returned by the IPv6 DHCP server. @@ -24,7 +25,8 @@ Options readable a{sv} - Configuration options returned by a DHCP server, if any. + +Configuration options returned by a DHCP server, if any. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Adsl.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Adsl.xml index 3b2695aa..7846247c 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Adsl.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Adsl.xml @@ -13,7 +13,9 @@ Description - + + + Property Details @@ -23,9 +25,11 @@ Carrier readable b - Indicates whether the physical carrier is found. - DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" - property on the "org.freedesktop.NetworkManager.Device" interface. + +Indicates whether the physical carrier is found. + +DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" +property on the "org.freedesktop.NetworkManager.Device" interface. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Bluetooth.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Bluetooth.xml index 6072730d..689ddce7 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Bluetooth.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Bluetooth.xml @@ -15,7 +15,9 @@ Description - + + + Property Details @@ -25,8 +27,10 @@ HwAddress readable s - Bluetooth hardware address of the device. - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. + +Bluetooth hardware address of the device. + +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. @@ -35,7 +39,8 @@ HwAddress readable s Name readable s - Bluetooth name of the device. + +Bluetooth name of the device. @@ -44,8 +49,10 @@ Name readable s BtCapabilities readable u - Bluetooth capabilities of the device (either DUN or NAP). - Returns: NMBluetoothCapabilities + +Bluetooth capabilities of the device (either DUN or NAP). + +Returns: NMBluetoothCapabilities diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Bond.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Bond.xml index f7fcacbd..34d1badf 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Bond.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Bond.xml @@ -15,7 +15,9 @@ Description - + + + Property Details @@ -25,9 +27,10 @@ HwAddress readable s - Hardware address of the device. + +Hardware address of the device. n - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. @@ -36,10 +39,12 @@ n Carrier readable b - Indicates whether the physical carrier is found (e.g. whether a cable is - plugged in or not). - DEPRECATED: check for the "lower-up" flag in the "InterfaceFlags" - property on the "org.freedesktop.NetworkManager.Device" interface. + +Indicates whether the physical carrier is found (e.g. whether a cable is +plugged in or not). + +DEPRECATED: check for the "lower-up" flag in the "InterfaceFlags" +property on the "org.freedesktop.NetworkManager.Device" interface. @@ -48,9 +53,10 @@ Carrier readable b Slaves readable ao - DEPRECATED. Use the "Ports" property in - "org.freedesktop.NetworkManager.Device" instead which exists since - version NetworkManager 1.34.0. + +DEPRECATED. Use the "Ports" property in +"org.freedesktop.NetworkManager.Device" instead which exists since +version NetworkManager 1.34.0. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Bridge.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Bridge.xml index 7fa0aad6..18dd8e74 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Bridge.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Bridge.xml @@ -15,7 +15,9 @@ Description - + + + Property Details @@ -25,9 +27,10 @@ HwAddress readable s - Hardware address of the device. + +Hardware address of the device. n - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. @@ -36,10 +39,12 @@ n Carrier readable b - Indicates whether the physical carrier is found (e.g. whether a cable is - plugged in or not). - DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" - property on the "org.freedesktop.NetworkManager.Device" interface. + +Indicates whether the physical carrier is found (e.g. whether a cable is +plugged in or not). + +DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" +property on the "org.freedesktop.NetworkManager.Device" interface. @@ -48,9 +53,10 @@ Carrier readable b Slaves readable ao - DEPRECATED. Use the "Ports" property in - "org.freedesktop.NetworkManager.Device" instead which exists since - version NetworkManager 1.34.0. + +DEPRECATED. Use the "Ports" property in +"org.freedesktop.NetworkManager.Device" instead which exists since +version NetworkManager 1.34.0. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Dummy.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Dummy.xml index 62b26cce..05ca8ed9 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Dummy.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Dummy.xml @@ -13,7 +13,9 @@ Description - + + + Property Details @@ -23,9 +25,10 @@ HwAddress readable s - Hardware address of the device. + +Hardware address of the device. n - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Generic.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Generic.xml index 3a353bf6..f907a844 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Generic.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Generic.xml @@ -14,7 +14,9 @@ Description - + + + Property Details @@ -24,9 +26,10 @@ HwAddress readable s - Hardware address of the device. + +Hardware address of the device. n - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. @@ -35,7 +38,8 @@ n TypeDescription readable s - A (non-localized) description of the interface type, if known. + +A (non-localized) description of the interface type, if known. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.IPTunnel.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.IPTunnel.xml index f57e395f..ffd540f8 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.IPTunnel.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.IPTunnel.xml @@ -24,7 +24,9 @@ Description - + + + Property Details @@ -34,7 +36,8 @@ Mode readable u - The tunneling mode. + +The tunneling mode. @@ -43,7 +46,8 @@ Mode readable u Parent readable o - The object path of the parent device. + +The object path of the parent device. @@ -52,7 +56,8 @@ Parent readable o Local readable s - The local endpoint of the tunnel. + +The local endpoint of the tunnel. @@ -61,7 +66,8 @@ Local readable s Remote readable s - The remote endpoint of the tunnel. + +The remote endpoint of the tunnel. @@ -70,8 +76,9 @@ Remote readable s Ttl readable y - The TTL assigned to tunneled packets. 0 is a special value meaning that - packets inherit the TTL value + +The TTL assigned to tunneled packets. 0 is a special value meaning that +packets inherit the TTL value @@ -80,8 +87,9 @@ Ttl readable y Tos readable y - The type of service (IPv4) or traffic class (IPv6) assigned to tunneled - packets. + +The type of service (IPv4) or traffic class (IPv6) assigned to tunneled +packets. @@ -90,7 +98,8 @@ Tos readable y PathMtuDiscovery readable b - Whether path MTU discovery is enabled on this tunnel. + +Whether path MTU discovery is enabled on this tunnel. @@ -99,7 +108,8 @@ PathMtuDiscovery readable b InputKey readable s - The key used for incoming packets. + +The key used for incoming packets. @@ -108,7 +118,8 @@ InputKey readable s OutputKey readable s - The key used for outgoing packets. + +The key used for outgoing packets. @@ -117,8 +128,9 @@ OutputKey readable s EncapsulationLimit readable y - 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. @@ -127,8 +139,9 @@ EncapsulationLimit readable y FlowLabel readable u - 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. @@ -137,7 +150,8 @@ FlowLabel readable u Flags readable u - Tunnel flags. + +Tunnel flags. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Infiniband.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Infiniband.xml index ae354cd6..ed6533ae 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Infiniband.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Infiniband.xml @@ -14,7 +14,9 @@ Description - + + + Property Details @@ -24,9 +26,10 @@ HwAddress readable s - Hardware address of the device. + +Hardware address of the device. n - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. @@ -35,10 +38,12 @@ n Carrier readable b - Indicates whether the physical carrier is found (e.g. whether a cable is - plugged in or not). - DEPRECATED: check for the "lower-up" flag in the "InterfaceFlags" - property on the "org.freedesktop.NetworkManager.Device" interface. + +Indicates whether the physical carrier is found (e.g. whether a cable is +plugged in or not). + +DEPRECATED: check for the "lower-up" flag in the "InterfaceFlags" +property on the "org.freedesktop.NetworkManager.Device" interface. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Macsec.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Macsec.xml index 4b1b6a2c..17b772ba 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Macsec.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Macsec.xml @@ -25,7 +25,9 @@ Description - + + + Property Details @@ -35,7 +37,8 @@ Parent readable o - The object path of the parent device. + +The object path of the parent device. @@ -44,7 +47,8 @@ Parent readable o Sci readable t - The Secure Channel Identifier in use. + +The Secure Channel Identifier in use. @@ -53,7 +57,8 @@ Sci readable t IcvLength readable y - The length of ICV (Integrity Check Value). + +The length of ICV (Integrity Check Value). @@ -62,8 +67,9 @@ IcvLength readable y CipherSuite readable t - The set of cryptographic algorithms in use - (e.g. 0x0080020001000001 for GCM-AES-128). + +The set of cryptographic algorithms in use +(e.g. 0x0080020001000001 for GCM-AES-128). @@ -72,7 +78,8 @@ CipherSuite readable t Window readable u - The size of the replay window. + +The size of the replay window. @@ -81,8 +88,9 @@ Window readable u EncodingSa readable y - The value of the Association Number (0..3) for the Security - Association in use. + +The value of the Association Number (0..3) for the Security +Association in use. @@ -91,8 +99,9 @@ EncodingSa readable y Validation readable s - The validation mode for incoming packets (strict, check, - disabled). + +The validation mode for incoming packets (strict, check, +disabled). @@ -101,7 +110,8 @@ Validation readable s Encrypt readable b - Whether encryption of transmitted frames is enabled. + +Whether encryption of transmitted frames is enabled. @@ -110,7 +120,8 @@ Encrypt readable b Protect readable b - Whether protection of transmitted frames is enabled. + +Whether protection of transmitted frames is enabled. @@ -119,8 +130,9 @@ Protect readable b IncludeSci readable b - Whether the SCI is always included in SecTAG for transmitted - frames. + +Whether the SCI is always included in SecTAG for transmitted +frames. @@ -129,8 +141,9 @@ IncludeSci readable b Es readable b - Whether the ES (End station) bit is enabled in SecTAG for - transmitted frames. + +Whether the ES (End station) bit is enabled in SecTAG for +transmitted frames. @@ -139,8 +152,9 @@ Es readable b Scb readable b - Whether the SCB (Single Copy Broadcast) bit is enabled in - SecTAG for transmitted frames. + +Whether the SCB (Single Copy Broadcast) bit is enabled in +SecTAG for transmitted frames. @@ -149,7 +163,8 @@ Scb readable b ReplayProtect readable b - Whether replay protection is enabled. + +Whether replay protection is enabled. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Macvlan.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Macvlan.xml index 5d8b8d45..bec10ff1 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Macvlan.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Macvlan.xml @@ -16,7 +16,9 @@ Description - + + + Property Details @@ -26,7 +28,8 @@ Parent readable o - The object path of the parent device. + +The object path of the parent device. @@ -35,7 +38,8 @@ Parent readable o Mode readable s - The macvlan mode, one of "private", "vepa", "bridge", or "passthru". + +The macvlan mode, one of "private", "vepa", "bridge", or "passthru". @@ -44,7 +48,8 @@ Mode readable s NoPromisc readable b - Whether the device is blocked from going into promiscuous mode. + +Whether the device is blocked from going into promiscuous mode. @@ -53,7 +58,8 @@ NoPromisc readable b Tap readable b - Whether the device is a macvtap. + +Whether the device is a macvtap. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Modem.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Modem.xml index 1eedf1f7..49c4e009 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Modem.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Modem.xml @@ -17,7 +17,9 @@ Description - + + + Property Details @@ -27,11 +29,13 @@ ModemCapabilities readable u - The generic family of access technologies the modem supports. Not all - capabilities are available at the same time however; some modems require a - firmware reload or other reinitialization to switch between eg CDMA/EVDO - and GSM/UMTS. - Returns: NMDeviceModemCapabilities + +The generic family of access technologies the modem supports. Not all +capabilities are available at the same time however; some modems require a +firmware reload or other reinitialization to switch between eg CDMA/EVDO +and GSM/UMTS. + +Returns: NMDeviceModemCapabilities @@ -40,9 +44,11 @@ ModemCapabilities readable u CurrentCapabilities readable u - The generic family of access technologies the modem currently supports - without a firmware reload or reinitialization. - Returns: NMDeviceModemCapabilities + +The generic family of access technologies the modem currently supports +without a firmware reload or reinitialization. + +Returns: NMDeviceModemCapabilities @@ -51,9 +57,10 @@ CurrentCapabilities readable u DeviceId readable s - An identifier used by the modem backend (ModemManager) that aims to - uniquely identify the a device. Can be used to match a connection to a - particular device. + +An identifier used by the modem backend (ModemManager) that aims to +uniquely identify the a device. Can be used to match a connection to a +particular device. Since 1.20 @@ -63,8 +70,9 @@ DeviceId readable s OperatorCode readable s - The MCC and MNC (concatenated) of the network the modem is connected to. - Blank if disconnected or not a 3GPP modem. + +The MCC and MNC (concatenated) of the network the modem is connected to. +Blank if disconnected or not a 3GPP modem. Since 1.20 @@ -74,7 +82,8 @@ OperatorCode readable s Apn readable s - The access point name the modem is connected to. Blank if disconnected. + +The access point name the modem is connected to. Blank if disconnected. Since 1.20 diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.OlpcMesh.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.OlpcMesh.xml index cb71a023..8fc2d33f 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.OlpcMesh.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.OlpcMesh.xml @@ -15,7 +15,9 @@ Description - + + + Property Details @@ -25,8 +27,10 @@ HwAddress readable s - The hardware address of the device. - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. + +The hardware address of the device. + +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. @@ -35,7 +39,8 @@ HwAddress readable s Companion readable o - The object path of the companion device. + +The object path of the companion device. @@ -44,7 +49,8 @@ Companion readable o ActiveChannel readable u - The currently active channel. + +The currently active channel. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Statistics.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Statistics.xml index fce89f6d..97fa4586 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Statistics.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Statistics.xml @@ -15,7 +15,9 @@ Description - + + + Property Details @@ -25,10 +27,11 @@ RefreshRateMs readwrite u - Refresh rate of the rest of properties of this interface. The properties - are guaranteed to be refreshed each RefreshRateMs milliseconds in case - the underlying counter has changed too. - If zero, there is no guaranteed refresh rate of the properties. + +Refresh rate of the rest of properties of this interface. The properties +are guaranteed to be refreshed each RefreshRateMs milliseconds in case +the underlying counter has changed too. +If zero, there is no guaranteed refresh rate of the properties. @@ -37,7 +40,8 @@ RefreshRateMs readwrite u TxBytes readable t - Number of transmitted bytes + +Number of transmitted bytes @@ -46,7 +50,8 @@ TxBytes readable t RxBytes readable t - Number of received bytes + +Number of received bytes diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Team.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Team.xml index ce1889e3..d63bad6a 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Team.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Team.xml @@ -16,7 +16,9 @@ Description - + + + Property Details @@ -26,9 +28,10 @@ HwAddress readable s - Hardware address of the device. + +Hardware address of the device. n - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. @@ -37,10 +40,12 @@ n Carrier readable b - Indicates whether the physical carrier is found (e.g. whether a cable is - plugged in or not). - DEPRECATED: check for the "lower-up" flag in the "InterfaceFlags" - property on the "org.freedesktop.NetworkManager.Device" interface. + +Indicates whether the physical carrier is found (e.g. whether a cable is +plugged in or not). + +DEPRECATED: check for the "lower-up" flag in the "InterfaceFlags" +property on the "org.freedesktop.NetworkManager.Device" interface. @@ -49,9 +54,10 @@ Carrier readable b Slaves readable ao - DEPRECATED. Use the "Ports" property in - "org.freedesktop.NetworkManager.Device" instead which exists since - version NetworkManager 1.34.0. + +DEPRECATED. Use the "Ports" property in +"org.freedesktop.NetworkManager.Device" instead which exists since +version NetworkManager 1.34.0. @@ -60,7 +66,8 @@ Slaves readable ao Config readable s - The JSON configuration currently applied on the device. + +The JSON configuration currently applied on the device. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Tun.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Tun.xml index 5f1ea7e4..0b5f198a 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Tun.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Tun.xml @@ -19,7 +19,9 @@ Description - + + + Property Details @@ -29,7 +31,8 @@ Owner readable x - The uid of the tunnel owner, or -1 if it has no owner. + +The uid of the tunnel owner, or -1 if it has no owner. @@ -38,7 +41,8 @@ Owner readable x Group readable x - The gid of the tunnel group, or -1 if it has no owner. + +The gid of the tunnel group, or -1 if it has no owner. @@ -47,7 +51,8 @@ Group readable x Mode readable s - The tunnel mode, either "tun" or "tap". + +The tunnel mode, either "tun" or "tap". @@ -56,8 +61,9 @@ Mode readable s NoPi readable b - The tunnel's "TUN_NO_PI" flag; true if no protocol info is prepended to - the tunnel packets. + +The tunnel's "TUN_NO_PI" flag; true if no protocol info is prepended to +the tunnel packets. @@ -66,8 +72,9 @@ NoPi readable b VnetHdr readable b - The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets include a - virtio network header. + +The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets include a +virtio network header. @@ -76,8 +83,9 @@ VnetHdr readable b MultiQueue readable b - The tunnel's "TUN_TAP_MQ" flag; true if callers can connect to the tap - device multiple times, for multiple send/receive queues. + +The tunnel's "TUN_TAP_MQ" flag; true if callers can connect to the tap +device multiple times, for multiple send/receive queues. @@ -86,9 +94,10 @@ MultiQueue readable b HwAddress readable s - Hardware address of the device. + +Hardware address of the device. n - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Veth.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Veth.xml index 3e34a661..fba9ac92 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Veth.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Veth.xml @@ -13,7 +13,9 @@ Description - + + + Property Details @@ -23,7 +25,8 @@ Peer readable o - The object path of the device's peer. + +The object path of the device's peer. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Vlan.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Vlan.xml index 21e224ad..2752e5b6 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Vlan.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Vlan.xml @@ -16,7 +16,9 @@ Description - + + + Property Details @@ -26,9 +28,10 @@ HwAddress readable s - Hardware address of the device. + +Hardware address of the device. n - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. @@ -37,10 +40,12 @@ n Carrier readable b - Indicates whether the physical carrier is found (e.g. whether a cable is - plugged in or not). - DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" - property on the "org.freedesktop.NetworkManager.Device" interface. + +Indicates whether the physical carrier is found (e.g. whether a cable is +plugged in or not). + +DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" +property on the "org.freedesktop.NetworkManager.Device" interface. @@ -49,7 +54,8 @@ Carrier readable b Parent readable o - Object path of the parent device of this VLAN device. + +Object path of the parent device of this VLAN device. @@ -58,7 +64,8 @@ Parent readable o VlanId readable u - The VLAN ID of this VLAN interface. + +The VLAN ID of this VLAN interface. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Vxlan.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Vxlan.xml index 9b11c25a..b4940213 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Vxlan.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Vxlan.xml @@ -29,7 +29,9 @@ Description - + + + Property Details @@ -39,8 +41,9 @@ Parent readable o - The object path of the parent device (if the VXLAN is not purely internal - to this host). + +The object path of the parent device (if the VXLAN is not purely internal +to this host). @@ -49,9 +52,10 @@ Parent readable o HwAddress readable s - Hardware address of the device. + +Hardware address of the device. n - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. @@ -60,7 +64,8 @@ n Id readable u - The VXLAN Network Identifier (VNI). + +The VXLAN Network Identifier (VNI). @@ -69,8 +74,9 @@ Id readable u Group readable s - The IP (v4 or v6) multicast group used to communicate with other physical - hosts on this VXLAN. + +The IP (v4 or v6) multicast group used to communicate with other physical +hosts on this VXLAN. @@ -79,8 +85,9 @@ Group readable s Local readable s - The local IPv4 or IPv6 address to use when sending VXLAN packets to other - physical hosts. + +The local IPv4 or IPv6 address to use when sending VXLAN packets to other +physical hosts. @@ -89,8 +96,9 @@ Local readable s Tos readable y - The value to use in the IP ToS field for VXLAN packets sent to other - physical hosts. + +The value to use in the IP ToS field for VXLAN packets sent to other +physical hosts. @@ -99,8 +107,9 @@ Tos readable y Ttl readable y - The value to use in the IP TTL field for VXLAN packets sent to other - physical hosts. + +The value to use in the IP TTL field for VXLAN packets sent to other +physical hosts. @@ -109,7 +118,8 @@ Ttl readable y Learning readable b - True if the VXLAN dynamically learns remote IP addresses. + +True if the VXLAN dynamically learns remote IP addresses. @@ -118,7 +128,8 @@ Learning readable b Ageing readable u - The interval in seconds at which the kernel purges stale cached addresses. + +The interval in seconds at which the kernel purges stale cached addresses. @@ -127,8 +138,9 @@ Ageing readable u Limit readable u - The maximum number of entries that can be added to the VXLAN's forwarding - table. + +The maximum number of entries that can be added to the VXLAN's forwarding +table. @@ -137,7 +149,8 @@ Limit readable u DstPort readable q - Destination port for outgoing VXLAN packets. + +Destination port for outgoing VXLAN packets. @@ -146,7 +159,8 @@ DstPort readable q SrcPortMin readable q - The lowest source port number to use for outgoing VXLAN packets. + +The lowest source port number to use for outgoing VXLAN packets. @@ -155,7 +169,8 @@ SrcPortMin readable q SrcPortMax readable q - The highest source port number to use for outgoing VXLAN packets. + +The highest source port number to use for outgoing VXLAN packets. @@ -164,7 +179,8 @@ SrcPortMax readable q Proxy readable b - True if the VXLAN is implementing DOVE ARP proxying for remote clients. + +True if the VXLAN is implementing DOVE ARP proxying for remote clients. @@ -173,8 +189,9 @@ Proxy readable b Rsc readable b - True if the VXLAN is implementing DOVE route short-circuiting of known - remote IP addresses. + +True if the VXLAN is implementing DOVE route short-circuiting of known +remote IP addresses. @@ -183,7 +200,8 @@ Rsc readable b L2miss readable b - True if the VXLAN will emit netlink notifications of L2 switch misses. + +True if the VXLAN will emit netlink notifications of L2 switch misses. @@ -192,7 +210,8 @@ L2miss readable b L3miss readable b - True if the VXLAN will emit netlink notifications of L3 switch misses. + +True if the VXLAN will emit netlink notifications of L3 switch misses. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.WifiP2P.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.WifiP2P.xml index 78d31736..f34c309b 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.WifiP2P.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.WifiP2P.xml @@ -28,7 +28,9 @@ Description - + + + Since 1.16 @@ -39,20 +41,25 @@ StartFind (IN a{sv} options); - Start a find operation for Wi-Fi P2P peers. - The options argument accepts the following keys: - - - i timeout: - Timeout value in the range of 1-600 seconds. - The default is 30 seconds. - - + +Start a find operation for Wi-Fi P2P peers. + +The options argument accepts the following keys: + + + +i timeout: +Timeout value in the range of 1-600 seconds. +The default is 30 seconds. + + IN a{sv} options: - Options of find. + +Options of find. + Since 1.16 @@ -63,7 +70,8 @@ StartFind (IN a{sv} options); StopFind (); - Stop an ongoing find operation again. + +Stop an ongoing find operation again. Since 1.16 @@ -76,12 +84,15 @@ StopFind (); PeerAdded (o peer); - Emitted when a new Wi-Fi P2P peer is found by the device. + +Emitted when a new Wi-Fi P2P peer is found by the device. o peer: - The object path of the newly found access point. + +The object path of the newly found access point. + Since 1.16 @@ -92,12 +103,15 @@ PeerAdded (o peer); PeerRemoved (o peer); - Emitted when a Wi-Fi P2P peer disappears from view of the device. + +Emitted when a Wi-Fi P2P peer disappears from view of the device. o peer: - The object path of the Wi-Fi P2P peer that has disappeared. + +The object path of the Wi-Fi P2P peer that has disappeared. + Since 1.16 @@ -111,8 +125,10 @@ PeerRemoved (o peer); HwAddress readable s - The active hardware address of the device. - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. + +The active hardware address of the device. + +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. Since 1.16 @@ -122,7 +138,8 @@ HwAddress readable s Peers readable ao - List of object paths of peers visible to this Wi-Fi P2P device. + +List of object paths of peers visible to this Wi-Fi P2P device. Since 1.16 diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.WireGuard.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.WireGuard.xml index 0c6fa36e..3a754296 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.WireGuard.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.WireGuard.xml @@ -15,7 +15,9 @@ Description - + + + Property Details @@ -25,7 +27,8 @@ PublicKey readable ay - 32-byte public WireGuard key. + +32-byte public WireGuard key. @@ -34,7 +37,8 @@ PublicKey readable ay ListenPort readable q - Local UDP listening port. + +Local UDP listening port. @@ -43,8 +47,9 @@ ListenPort readable q FwMark readable u - Optional 32-bit mark used to set routing policy for outgoing encrypted packets. - See: ip-rule(8) + +Optional 32-bit mark used to set routing policy for outgoing encrypted packets. +See: ip-rule(8) diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Wired.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Wired.xml index 8f92f11a..320300db 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Wired.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Wired.xml @@ -17,7 +17,9 @@ Description - + + + Property Details @@ -27,8 +29,10 @@ HwAddress readable s - Active hardware address of the device. - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. + +Active hardware address of the device. + +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. @@ -37,7 +41,8 @@ HwAddress readable s PermHwAddress readable s - Permanent hardware address of the device. + +Permanent hardware address of the device. @@ -46,7 +51,8 @@ PermHwAddress readable s Speed readable u - Design speed of the device, in megabits/second (Mb/s). + +Design speed of the device, in megabits/second (Mb/s). @@ -55,7 +61,8 @@ Speed readable u S390Subchannels readable as - Array of S/390 subchannels for S/390 or z/Architecture devices. + +Array of S/390 subchannels for S/390 or z/Architecture devices. @@ -64,10 +71,12 @@ S390Subchannels readable as Carrier readable b - Indicates whether the physical carrier is found (e.g. whether a cable is - plugged in or not). - DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" - property on the "org.freedesktop.NetworkManager.Device" interface. + +Indicates whether the physical carrier is found (e.g. whether a cable is +plugged in or not). + +DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" +property on the "org.freedesktop.NetworkManager.Device" interface. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Wireless.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Wireless.xml index 7987e594..8a2e6740 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.Wireless.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.Wireless.xml @@ -35,7 +35,9 @@ Description - + + + Method Details @@ -45,15 +47,18 @@ GetAccessPoints (OUT ao access_points); - DEPRECATED. Get the list of access points visible to this device. Note - that this list does not include access points which hide their SSID. To - retrieve a list of all access points (including hidden ones) use the - GetAllAccessPoints() method. + +DEPRECATED. Get the list of access points visible to this device. Note +that this list does not include access points which hide their SSID. To +retrieve a list of all access points (including hidden ones) use the +GetAllAccessPoints() method. OUT ao access_points: - List of access point object paths. + +List of access point object paths. + @@ -63,13 +68,16 @@ GetAccessPoints (OUT ao access_points); GetAllAccessPoints (OUT ao access_points); - Get the list of all access points visible to this device, including hidden - ones for which the SSID is not yet known. + +Get the list of all access points visible to this device, including hidden +ones for which the SSID is not yet known. OUT ao access_points: - List of access point object paths. + +List of access point object paths. + @@ -79,12 +87,15 @@ GetAllAccessPoints (OUT ao access_points); RequestScan (IN a{sv} options); - Request the device to scan. To know when the scan is finished, use the "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" to listen to changes to the "LastScan" property. + +Request the device to scan. To know when the scan is finished, use the "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" to listen to changes to the "LastScan" property. IN a{sv} options: - Options of scan. Currently, 'ssids' option with value of "aay" type is supported. + +Options of scan. Currently, 'ssids' option with value of "aay" type is supported. + @@ -97,12 +108,15 @@ RequestScan (IN a{sv} options); AccessPointAdded (o access_point); - Emitted when a new access point is found by the device. + +Emitted when a new access point is found by the device. o access_point: - The object path of the newly found access point. + +The object path of the newly found access point. + @@ -112,12 +126,15 @@ AccessPointAdded (o access_point); AccessPointRemoved (o access_point); - Emitted when an access point disappears from view of the device. + +Emitted when an access point disappears from view of the device. o access_point: - The object path of the access point that has disappeared. + +The object path of the access point that has disappeared. + @@ -130,8 +147,10 @@ AccessPointRemoved (o access_point); HwAddress readable s - The active hardware address of the device. - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. + +The active hardware address of the device. + +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. @@ -140,7 +159,8 @@ HwAddress readable s PermHwAddress readable s - The permanent hardware address of the device. + +The permanent hardware address of the device. @@ -149,8 +169,10 @@ PermHwAddress readable s Mode readable u - The operating mode of the wireless device. - Returns: NM80211Mode + +The operating mode of the wireless device. + +Returns: NM80211Mode @@ -159,8 +181,9 @@ Mode readable u Bitrate readable u - The bit rate currently used by the wireless device, in kilobits/second - (Kb/s). + +The bit rate currently used by the wireless device, in kilobits/second +(Kb/s). @@ -169,7 +192,8 @@ Bitrate readable u AccessPoints readable ao - List of object paths of access point visible to this wireless device. + +List of object paths of access point visible to this wireless device. @@ -178,7 +202,8 @@ AccessPoints readable ao ActiveAccessPoint readable o - Object path of the access point currently used by the wireless device. + +Object path of the access point currently used by the wireless device. @@ -187,8 +212,10 @@ ActiveAccessPoint readable o WirelessCapabilities readable u - The capabilities of the wireless device. - Returns: NMDeviceWifiCapabilities + +The capabilities of the wireless device. + +Returns: NMDeviceWifiCapabilities @@ -197,8 +224,9 @@ WirelessCapabilities readable u LastScan readable x - The timestamp (in CLOCK_BOOTTIME milliseconds) for the last finished network scan. - A value of -1 means the device never scanned for access points. + +The timestamp (in CLOCK_BOOTTIME milliseconds) for the last finished network scan. +A value of -1 means the device never scanned for access points. Since 1.12 diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.xml index cf1410be..0d73ca72 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Device.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.xml @@ -65,7 +65,9 @@ Description - + + + Method Details @@ -77,39 +79,46 @@ Reapply (IN a{sa{sv}} connection, IN t version_id, IN u flags); - Attempts to update the configuration of a device without deactivating it. - NetworkManager has the concept of connections, which are profiles that - contain the configuration for a networking device. Those connections are - exposed via D-Bus as individual objects that can be created, modified and - deleted. When activating such a settings-connection on a device, the - settings-connection is cloned to become an applied-connection and used to - configure the device (see GetAppliedConnection). Subsequent modification - of the settings-connection don't propagate automatically to the device's - applied-connection (with exception of the firewall-zone and the metered - property). For the changes to take effect, you can either re-activate the - settings-connection, or call Reapply. The Reapply call allows you to - directly update the applied-connection and reconfigure the device. Reapply - can also be useful if the currently applied-connection is equal to the - connection that is about to be reapplied. This allows to reconfigure the - device and revert external changes like removing or adding an IP address - (which NetworkManager doesn't revert automatically because it is assumed - that the user made these changes intentionally outside of NetworkManager). - Reapply can make the applied-connection different from the - settings-connection, just like updating the settings-connection can make - them different. + +Attempts to update the configuration of a device without deactivating it. +NetworkManager has the concept of connections, which are profiles that +contain the configuration for a networking device. Those connections are +exposed via D-Bus as individual objects that can be created, modified and +deleted. When activating such a settings-connection on a device, the +settings-connection is cloned to become an applied-connection and used to +configure the device (see GetAppliedConnection). Subsequent modification +of the settings-connection don't propagate automatically to the device's +applied-connection (with exception of the firewall-zone and the metered +property). For the changes to take effect, you can either re-activate the +settings-connection, or call Reapply. The Reapply call allows you to +directly update the applied-connection and reconfigure the device. Reapply +can also be useful if the currently applied-connection is equal to the +connection that is about to be reapplied. This allows to reconfigure the +device and revert external changes like removing or adding an IP address +(which NetworkManager doesn't revert automatically because it is assumed +that the user made these changes intentionally outside of NetworkManager). +Reapply can make the applied-connection different from the +settings-connection, just like updating the settings-connection can make +them different. IN a{sa{sv}} connection: - The optional connection settings that will be reapplied on the device. If empty, the currently active settings-connection will be used. The connection cannot arbitrarily differ from the current applied-connection otherwise the call will fail. Only certain changes are supported, like adding or removing IP addresses. + +The optional connection settings that will be reapplied on the device. If empty, the currently active settings-connection will be used. The connection cannot arbitrarily differ from the current applied-connection otherwise the call will fail. Only certain changes are supported, like adding or removing IP addresses. + IN t version_id: - If non-zero, the current version id of the applied-connection must match. The current version id can be retrieved via GetAppliedConnection. This optional argument allows to catch concurrent modifications between the GetAppliedConnection call and Reapply. + +If non-zero, the current version id of the applied-connection must match. The current version id can be retrieved via GetAppliedConnection. This optional argument allows to catch concurrent modifications between the GetAppliedConnection call and Reapply. + IN u flags: - Flags which would modify the behavior of the Reapply call. There are no flags defined currently and the users should use the value of 0. + +Flags which would modify the behavior of the Reapply call. There are no flags defined currently and the users should use the value of 0. + @@ -121,26 +130,33 @@ GetAppliedConnection (IN u flags, OUT a{sa{sv}} connection, OUT t version_id); - Get the currently applied connection on the device. This is a snapshot of - the last activated connection on the device, that is the configuration - that is currently applied on the device. Usually this is the same as - GetSettings of the referenced settings connection. However, it can differ - if the settings connection was subsequently modified or the applied - connection was modified by Reapply. The applied connection is set when - activating a device or when calling Reapply. + +Get the currently applied connection on the device. This is a snapshot of +the last activated connection on the device, that is the configuration +that is currently applied on the device. Usually this is the same as +GetSettings of the referenced settings connection. However, it can differ +if the settings connection was subsequently modified or the applied +connection was modified by Reapply. The applied connection is set when +activating a device or when calling Reapply. IN u flags: - Flags which would modify the behavior of the GetAppliedConnection call. There are no flags defined currently and the users should use the value of 0. + +Flags which would modify the behavior of the GetAppliedConnection call. There are no flags defined currently and the users should use the value of 0. + OUT a{sa{sv}} connection: - The effective connection settings that the connection has currently applied. + +The effective connection settings that the connection has currently applied. + OUT t version_id: - The version-id of the currently applied connection. This can be specified during Reapply to avoid races where you first fetch the applied connection, modify it and try to reapply it. If the applied connection is modified in the meantime, the version_id gets incremented and Reapply will fail. + +The version-id of the currently applied connection. This can be specified during Reapply to avoid races where you first fetch the applied connection, modify it and try to reapply it. If the applied connection is modified in the meantime, the version_id gets incremented and Reapply will fail. + @@ -150,8 +166,9 @@ GetAppliedConnection (IN u flags, Disconnect (); - Disconnects a device and prevents the device from automatically activating - further connections without user intervention. + +Disconnects a device and prevents the device from automatically activating +further connections without user intervention. @@ -160,9 +177,10 @@ Disconnect (); Delete (); - Deletes a software device from NetworkManager and removes the interface - from the system. The method returns an error when called for a hardware - device. + +Deletes a software device from NetworkManager and removes the interface +from the system. The method returns an error when called for a hardware +device. @@ -176,19 +194,27 @@ StateChanged (u new_state, u old_state, u reason); - + + + u new_state: - (NMDeviceState) The new state of the device. + +(NMDeviceState) The new state of the device. + u old_state: - (NMDeviceState) The previous state of the device. + +(NMDeviceState) The previous state of the device. + u reason: - (NMDeviceStateReason) A reason for the state transition. + +(NMDeviceStateReason) A reason for the state transition. + @@ -201,19 +227,21 @@ StateChanged (u new_state, Udi readable s - Operating-system specific transient device hardware identifier. This is an - opaque string representing the underlying hardware for the device, and - shouldn't be used to keep track of individual devices. For some device - types (Bluetooth, Modems) it is an identifier used by the hardware service - (ie bluez or ModemManager) to refer to that device, and client programs - use it get additional information from those services which NM does not - provide. The Udi is not guaranteed to be consistent across reboots or - hotplugs of the hardware. If you're looking for a way to uniquely track - each device in your application, use the object path. If you're looking - for a way to track a specific piece of hardware across reboot or hotplug, - use a MAC address or USB serial number. - Note that non-UTF-8 characters are backslash escaped. Use g_strcompress() - to obtain the true (non-UTF-8) string. + +Operating-system specific transient device hardware identifier. This is an +opaque string representing the underlying hardware for the device, and +shouldn't be used to keep track of individual devices. For some device +types (Bluetooth, Modems) it is an identifier used by the hardware service +(ie bluez or ModemManager) to refer to that device, and client programs +use it get additional information from those services which NM does not +provide. The Udi is not guaranteed to be consistent across reboots or +hotplugs of the hardware. If you're looking for a way to uniquely track +each device in your application, use the object path. If you're looking +for a way to track a specific piece of hardware across reboot or hotplug, +use a MAC address or USB serial number. + +Note that non-UTF-8 characters are backslash escaped. Use g_strcompress() +to obtain the true (non-UTF-8) string. @@ -222,9 +250,11 @@ Udi readable s Path readable s - The path of the device as exposed by the udev property ID_PATH. - Note that non-UTF-8 characters are backslash escaped. Use g_strcompress() - to obtain the true (non-UTF-8) string. + +The path of the device as exposed by the udev property ID_PATH. + +Note that non-UTF-8 characters are backslash escaped. Use g_strcompress() +to obtain the true (non-UTF-8) string. @@ -233,10 +263,11 @@ Path readable s Interface readable s - The name of the device's control (and often data) interface. - Note that non UTF-8 characters are backslash escaped, so the - resulting name may be longer then 15 characters. Use g_strcompress() - to revert the escaping. + +The name of the device's control (and often data) interface. +Note that non UTF-8 characters are backslash escaped, so the +resulting name may be longer then 15 characters. Use g_strcompress() +to revert the escaping. @@ -245,13 +276,14 @@ Interface readable s IpInterface readable s - The name of the device's data interface when available. This property may - not refer to the actual data interface until the device has successfully - established a data connection, indicated by the device's State becoming - ACTIVATED. - Note that non UTF-8 characters are backslash escaped, so the - resulting name may be longer then 15 characters. Use g_strcompress() - to revert the escaping. + +The name of the device's data interface when available. This property may +not refer to the actual data interface until the device has successfully +established a data connection, indicated by the device's State becoming +ACTIVATED. +Note that non UTF-8 characters are backslash escaped, so the +resulting name may be longer then 15 characters. Use g_strcompress() +to revert the escaping. @@ -260,9 +292,10 @@ IpInterface readable s Driver readable s - The driver handling the device. - Non-UTF-8 sequences are backslash escaped. Use g_strcompress() - to revert. + +The driver handling the device. +Non-UTF-8 sequences are backslash escaped. Use g_strcompress() +to revert. @@ -271,9 +304,10 @@ Driver readable s DriverVersion readable s - The version of the driver handling the device. - Non-UTF-8 sequences are backslash escaped. Use g_strcompress() - to revert. + +The version of the driver handling the device. +Non-UTF-8 sequences are backslash escaped. Use g_strcompress() +to revert. @@ -282,9 +316,10 @@ DriverVersion readable s FirmwareVersion readable s - The firmware version for the device. - Non-UTF-8 sequences are backslash escaped. Use g_strcompress() - to revert. + +The firmware version for the device. +Non-UTF-8 sequences are backslash escaped. Use g_strcompress() +to revert. @@ -293,8 +328,10 @@ FirmwareVersion readable s Capabilities readable u - Flags describing the capabilities of the device. - Returns: NMDeviceCapabilities + +Flags describing the capabilities of the device. + +Returns: NMDeviceCapabilities @@ -303,8 +340,9 @@ Capabilities readable u Ip4Address readable u - DEPRECATED; use the 'Addresses' property of the 'Ip4Config' object - instead. This property always returns 0.0.0.0 (numeric 0) as address. + +DEPRECATED; use the 'Addresses' property of the 'Ip4Config' object +instead. This property always returns 0.0.0.0 (numeric 0) as address. @@ -313,8 +351,10 @@ Ip4Address readable u State readable u - The current state of the device. - Returns: NMDeviceState + +The current state of the device. + +Returns: NMDeviceState @@ -323,8 +363,10 @@ State readable u StateReason readable (uu) - The current state and reason for changing to that state. - Returns: A tuple of NMDeviceState and NMDeviceStateReason. + +The current state and reason for changing to that state. + +Returns: A tuple of NMDeviceState and NMDeviceStateReason. @@ -333,10 +375,11 @@ StateReason readable (uu) ActiveConnection readable o - Object path of an ActiveConnection object that "owns" this device during - activation. The ActiveConnection object tracks the life-cycle of a - connection to a specific network and implements the - org.freedesktop.NetworkManager.Connection.Active D-Bus interface. + +Object path of an ActiveConnection object that "owns" this device during +activation. The ActiveConnection object tracks the life-cycle of a +connection to a specific network and implements the +org.freedesktop.NetworkManager.Connection.Active D-Bus interface. @@ -345,9 +388,10 @@ ActiveConnection readable o Ip4Config readable o - Object path of the Ip4Config object describing the configuration of the - device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED - state. + +Object path of the Ip4Config object describing the configuration of the +device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED +state. @@ -356,9 +400,10 @@ Ip4Config readable o Dhcp4Config readable o - Object path of the Dhcp4Config object describing the DHCP options returned - by the DHCP server. Only valid when the device is in the - NM_DEVICE_STATE_ACTIVATED state. + +Object path of the Dhcp4Config object describing the DHCP options returned +by the DHCP server. Only valid when the device is in the +NM_DEVICE_STATE_ACTIVATED state. @@ -367,9 +412,10 @@ Dhcp4Config readable o Ip6Config readable o - Object path of the Ip6Config object describing the configuration of the - device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED - state. + +Object path of the Ip6Config object describing the configuration of the +device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED +state. @@ -378,9 +424,10 @@ Ip6Config readable o Dhcp6Config readable o - Object path of the Dhcp6Config object describing the DHCP options returned - by the DHCP server. Only valid when the device is in the - NM_DEVICE_STATE_ACTIVATED state. + +Object path of the Dhcp6Config object describing the DHCP options returned +by the DHCP server. Only valid when the device is in the +NM_DEVICE_STATE_ACTIVATED state. @@ -389,10 +436,11 @@ Dhcp6Config readable o Managed readwrite b - Whether or not this device is managed by NetworkManager. Setting this - property has a similar effect to configuring the device as unmanaged via - the keyfile.unmanaged-devices setting in NetworkManager.conf. Changes to - this value are not persistent and lost after NetworkManager restart. + +Whether or not this device is managed by NetworkManager. Setting this +property has a similar effect to configuring the device as unmanaged via +the keyfile.unmanaged-devices setting in NetworkManager.conf. Changes to +this value are not persistent and lost after NetworkManager restart. @@ -401,11 +449,12 @@ Managed readwrite b Autoconnect readwrite b - If TRUE, indicates the device is allowed to autoconnect. If FALSE, manual - intervention is required before the device will automatically connect to a - known network, such as activating a connection using the device, or - setting this property to TRUE. This property cannot be set to TRUE for - default-unmanaged devices, since they never autoconnect. + +If TRUE, indicates the device is allowed to autoconnect. If FALSE, manual +intervention is required before the device will automatically connect to a +known network, such as activating a connection using the device, or +setting this property to TRUE. This property cannot be set to TRUE for +default-unmanaged devices, since they never autoconnect. @@ -414,8 +463,9 @@ Autoconnect readwrite b FirmwareMissing readable b - If TRUE, indicates the device is likely missing firmware necessary for its - operation. + +If TRUE, indicates the device is likely missing firmware necessary for its +operation. @@ -424,8 +474,9 @@ FirmwareMissing readable b NmPluginMissing readable b - If TRUE, indicates the NetworkManager plugin for the device is likely - missing or misconfigured. + +If TRUE, indicates the NetworkManager plugin for the device is likely +missing or misconfigured. @@ -434,8 +485,10 @@ NmPluginMissing readable b DeviceType readable u - The general type of the network device; ie Ethernet, Wi-Fi, etc. - Returns: NMDeviceType + +The general type of the network device; ie Ethernet, Wi-Fi, etc. + +Returns: NMDeviceType @@ -444,8 +497,9 @@ DeviceType readable u AvailableConnections readable ao - An array of object paths of every configured connection that is currently - 'available' through this device. + +An array of object paths of every configured connection that is currently +'available' through this device. @@ -454,10 +508,11 @@ AvailableConnections readable ao PhysicalPortId readable s - If non-empty, an (opaque) indicator of the physical network port - associated with the device. This can be used to recognize when two - seemingly-separate hardware devices are actually just different virtual - interfaces to the same physical port. + +If non-empty, an (opaque) indicator of the physical network port +associated with the device. This can be used to recognize when two +seemingly-separate hardware devices are actually just different virtual +interfaces to the same physical port. @@ -466,7 +521,8 @@ PhysicalPortId readable s Mtu readable u - The device MTU (maximum transmission unit). + +The device MTU (maximum transmission unit). @@ -475,9 +531,11 @@ Mtu readable u Metered readable u - Whether the amount of traffic flowing through the device is subject to - limitations, for example set by service providers. - Returns: NMMetered + +Whether the amount of traffic flowing through the device is subject to +limitations, for example set by service providers. + +Returns: NMMetered @@ -486,8 +544,9 @@ Metered readable u LldpNeighbors readable aa{sv} - Array of LLDP neighbors; each element is a dictionary mapping LLDP TLV - names to variant boxed values. + +Array of LLDP neighbors; each element is a dictionary mapping LLDP TLV +names to variant boxed values. @@ -496,9 +555,10 @@ LldpNeighbors readable aa{sv} Real readable b - True if the device exists, or False for placeholder devices that do not - yet exist but could be automatically created by NetworkManager if one of - their AvailableConnections was activated. + +True if the device exists, or False for placeholder devices that do not +yet exist but could be automatically created by NetworkManager if one of +their AvailableConnections was activated. @@ -507,8 +567,10 @@ Real readable b Ip4Connectivity readable u - The result of the last IPv4 connectivity check. - Returns: NMConnectivityState + +The result of the last IPv4 connectivity check. + +Returns: NMConnectivityState Since 1.16 @@ -518,8 +580,10 @@ Ip4Connectivity readable u Ip6Connectivity readable u - The result of the last IPv6 connectivity check. - Returns: NMConnectivityState + +The result of the last IPv6 connectivity check. + +Returns: NMConnectivityState Since 1.16 @@ -529,9 +593,10 @@ Ip6Connectivity readable u InterfaceFlags readable u - The flags of the network interface. See - NMDeviceInterfaceFlags for - the currently defined flags. + +The flags of the network interface. See +NMDeviceInterfaceFlags for +the currently defined flags. Since 1.22 @@ -541,8 +606,10 @@ InterfaceFlags readable u HwAddress readable s - The hardware address of the device. - This replaces the other 'HwAddress' properties on the device-specific D-Bus interfaces. + +The hardware address of the device. + +This replaces the other 'HwAddress' properties on the device-specific D-Bus interfaces. Since 1.24 @@ -552,10 +619,12 @@ HwAddress readable s Ports readable ao - The port devices of the controller device. - Array of object paths representing devices which are currently set as - port of this device. This replaces the 'Slaves' properties on the - device-specific D-Bus interfaces. + +The port devices of the controller device. + +Array of object paths representing devices which are currently set as +port of this device. This replaces the 'Slaves' properties on the +device-specific D-Bus interfaces. Since 1.34 diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.DnsManager.xml b/docs/api/dbus-org.freedesktop.NetworkManager.DnsManager.xml index 70b30f88..0488bd65 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.DnsManager.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.DnsManager.xml @@ -15,7 +15,8 @@ Description - The interface contains DNS-related information. + +The interface contains DNS-related information. @@ -26,7 +27,8 @@ Mode readable s - The current DNS processing mode. + +The current DNS processing mode. @@ -35,7 +37,8 @@ Mode readable s RcManager readable s - The current resolv.conf management mode. + +The current resolv.conf management mode. @@ -44,13 +47,14 @@ RcManager readable s Configuration readable aa{sv} - The current DNS configuration represented as an array of - dictionaries. Each dictionary has the "nameservers", - "priority" keys and, optionally, "interface" and "vpn". - "nameservers" is the list of DNS servers, "priority" their - relative priority, "interface" the interface on which these - servers are contacted, "vpn" a boolean telling whether the - configuration was obtained from a VPN connection. + +The current DNS configuration represented as an array of +dictionaries. Each dictionary has the "nameservers", +"priority" keys and, optionally, "interface" and "vpn". +"nameservers" is the list of DNS servers, "priority" their +relative priority, "interface" the interface on which these +servers are contacted, "vpn" a boolean telling whether the +configuration was obtained from a VPN connection. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.IP4Config.xml b/docs/api/dbus-org.freedesktop.NetworkManager.IP4Config.xml index 4f90746c..94a9ec44 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.IP4Config.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.IP4Config.xml @@ -25,7 +25,9 @@ Description - + + + Property Details @@ -35,9 +37,10 @@ Addresses readable aau - Array of arrays of IPv4 address/prefix/gateway. All 3 elements of each - array are in network byte order. Essentially: [(addr, prefix, gateway), - (addr, prefix, gateway), ...] Deprecated: use AddressData and Gateway + +Array of arrays of IPv4 address/prefix/gateway. All 3 elements of each +array are in network byte order. Essentially: [(addr, prefix, gateway), +(addr, prefix, gateway), ...] Deprecated: use AddressData and Gateway @@ -46,9 +49,10 @@ Addresses readable aau AddressData readable aa{sv} - Array of IP address data objects. All addresses will include "address" (an - IP address string), and "prefix" (a uint). Some addresses may include - additional attributes. + +Array of IP address data objects. All addresses will include "address" (an +IP address string), and "prefix" (a uint). Some addresses may include +additional attributes. @@ -57,7 +61,8 @@ AddressData readable aa{sv} Gateway readable s - The gateway in use. + +The gateway in use. @@ -66,11 +71,12 @@ Gateway readable s Routes readable aau - Arrays of IPv4 route/prefix/next-hop/metric. All 4 elements of each tuple - are in network byte order. 'route' and 'next hop' are IPv4 addresses, - while prefix and metric are simple unsigned integers. Essentially: - [(route, prefix, next-hop, metric), (route, prefix, next-hop, metric), - ...] Deprecated: use RouteData + +Arrays of IPv4 route/prefix/next-hop/metric. All 4 elements of each tuple +are in network byte order. 'route' and 'next hop' are IPv4 addresses, +while prefix and metric are simple unsigned integers. Essentially: +[(route, prefix, next-hop, metric), (route, prefix, next-hop, metric), +...] Deprecated: use RouteData @@ -79,9 +85,10 @@ Routes readable aau RouteData readable aa{sv} - Array of IP route data objects. All routes will include "dest" (an IP - address string) and "prefix" (a uint). Some routes may include "next-hop" - (an IP address string), "metric" (a uint), and additional attributes. + +Array of IP route data objects. All routes will include "dest" (an IP +address string) and "prefix" (a uint). Some routes may include "next-hop" +(an IP address string), "metric" (a uint), and additional attributes. @@ -90,7 +97,8 @@ RouteData readable aa{sv} Nameservers readable au - The nameservers in use. Deprecated: use NameserverData + +The nameservers in use. Deprecated: use NameserverData @@ -99,8 +107,9 @@ Nameservers readable au NameserverData readable aa{sv} - The nameservers in use. Currently, only the value "address" - is recognized (with an IP address string). + +The nameservers in use. Currently, only the value "address" +is recognized (with an IP address string). Since 1.14 @@ -110,7 +119,8 @@ NameserverData readable aa{sv} Domains readable as - A list of domains this address belongs to. + +A list of domains this address belongs to. @@ -119,7 +129,8 @@ Domains readable as Searches readable as - A list of dns searches. + +A list of dns searches. @@ -128,8 +139,9 @@ Searches readable as DnsOptions readable as - A list of DNS options that modify the behavior of the DNS resolver. See - resolv.conf(5) manual page for the list of supported options. + +A list of DNS options that modify the behavior of the DNS resolver. See +resolv.conf(5) manual page for the list of supported options. @@ -138,7 +150,8 @@ DnsOptions readable as DnsPriority readable i - The relative priority of DNS servers. + +The relative priority of DNS servers. @@ -147,8 +160,9 @@ DnsPriority readable i WinsServers readable au - The Windows Internet Name Service servers associated with the connection. - Each address is in network byte order. Deprecated: use WinsServerData + +The Windows Internet Name Service servers associated with the connection. +Each address is in network byte order. Deprecated: use WinsServerData @@ -157,7 +171,8 @@ WinsServers readable au WinsServerData readable as - The Windows Internet Name Service servers associated with the connection. + +The Windows Internet Name Service servers associated with the connection. Since 1.14 diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.IP6Config.xml b/docs/api/dbus-org.freedesktop.NetworkManager.IP6Config.xml index aebdc684..00074df2 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.IP6Config.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.IP6Config.xml @@ -22,7 +22,9 @@ Description - + + + Property Details @@ -32,8 +34,9 @@ Addresses readable a(ayuay) - Array of tuples of IPv6 address/prefix/gateway. Deprecated: use - AddressData and Gateway. + +Array of tuples of IPv6 address/prefix/gateway. Deprecated: use +AddressData and Gateway. @@ -42,9 +45,10 @@ Addresses readable a(ayuay) AddressData readable aa{sv} - Array of IP address data objects. All addresses will include "address" (an - IP address string), and "prefix" (a uint). Some addresses may include - additional attributes. + +Array of IP address data objects. All addresses will include "address" (an +IP address string), and "prefix" (a uint). Some addresses may include +additional attributes. @@ -53,7 +57,8 @@ AddressData readable aa{sv} Gateway readable s - The gateway in use. + +The gateway in use. @@ -62,7 +67,8 @@ Gateway readable s Routes readable a(ayuayu) - Tuples of IPv6 route/prefix/next-hop/metric. Deprecated: use RouteData + +Tuples of IPv6 route/prefix/next-hop/metric. Deprecated: use RouteData @@ -71,9 +77,10 @@ Routes readable a(ayuayu) RouteData readable aa{sv} - Array of IP route data objects. All routes will include "dest" (an IP - address string) and "prefix" (a uint). Some routes may include "next-hop" - (an IP address string), "metric" (a uint), and additional attributes. + +Array of IP route data objects. All routes will include "dest" (an IP +address string) and "prefix" (a uint). Some routes may include "next-hop" +(an IP address string), "metric" (a uint), and additional attributes. @@ -82,7 +89,8 @@ RouteData readable aa{sv} Nameservers readable aay - The nameservers in use. + +The nameservers in use. @@ -91,7 +99,8 @@ Nameservers readable aay Domains readable as - A list of domains this address belongs to. + +A list of domains this address belongs to. @@ -100,7 +109,8 @@ Domains readable as Searches readable as - A list of dns searches. + +A list of dns searches. @@ -109,8 +119,9 @@ Searches readable as DnsOptions readable as - A list of DNS options that modify the behavior of the DNS resolver. See - resolv.conf(5) manual page for the list of supported options. + +A list of DNS options that modify the behavior of the DNS resolver. See +resolv.conf(5) manual page for the list of supported options. @@ -119,7 +130,8 @@ DnsOptions readable as DnsPriority readable i - The relative priority of DNS servers. + +The relative priority of DNS servers. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.PPP.xml b/docs/api/dbus-org.freedesktop.NetworkManager.PPP.xml index aae14d35..a2222ff5 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.PPP.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.PPP.xml @@ -18,7 +18,9 @@ Description - + + + Method Details @@ -29,15 +31,21 @@ NeedSecrets (OUT s username, OUT s password); - + + + OUT s username: - + + + OUT s password: - + + + @@ -47,11 +55,15 @@ NeedSecrets (OUT s username, SetIp4Config (IN a{sv} config); - + + + IN a{sv} config: - + + + @@ -61,11 +73,15 @@ SetIp4Config (IN a{sv} config); SetIp6Config (IN a{sv} config); - + + + IN a{sv} config: - + + + @@ -75,11 +91,15 @@ SetIp6Config (IN a{sv} config); SetState (IN u state); - + + + IN u state: - + + + @@ -89,11 +109,15 @@ SetState (IN u state); SetIfindex (IN i ifindex); - + + + IN i ifindex: - + + + diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.SecretAgent.xml b/docs/api/dbus-org.freedesktop.NetworkManager.SecretAgent.xml index 3a9cfa42..69e76573 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.SecretAgent.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.SecretAgent.xml @@ -24,15 +24,16 @@ Description - Private D-Bus interface used by secret agents that store and provide - secrets to NetworkManager. If an agent provides secrets to NetworkManager - as part of connection creation, and the some of those secrets are "agent - owned" the agent should store those secrets itself and should not expect - its SaveSecrets() method to be called. SaveSecrets() will be called eg if - some program other than the agent itself (like a connection editor) - changes the secrets out of band. The agent should implement this D-Bus - interface on an object with the path - /org/freedesktop/NetworkManager/SecretAgent. + +Private D-Bus interface used by secret agents that store and provide +secrets to NetworkManager. If an agent provides secrets to NetworkManager +as part of connection creation, and the some of those secrets are "agent +owned" the agent should store those secrets itself and should not expect +its SaveSecrets() method to be called. SaveSecrets() will be called eg if +some program other than the agent itself (like a connection editor) +changes the secrets out of band. The agent should implement this D-Bus +interface on an object with the path +/org/freedesktop/NetworkManager/SecretAgent. @@ -48,38 +49,51 @@ GetSecrets (IN a{sa{sv}} connection, IN u flags, OUT a{sa{sv}} secrets); - Retrieve and return stored secrets, if any, or request new secrets from - the agent's user. If user interaction is allowed and the user enters new - secrets, the agent is expected to save the new secrets to persistent - storage (if the secret's flags include AGENT_OWNED) as NetworkManager will - not send these secrets back to the same agent via a SaveSecrets() call. If - the user canceled any interaction, the agent should return the - UserCanceled error (see below). + +Retrieve and return stored secrets, if any, or request new secrets from +the agent's user. If user interaction is allowed and the user enters new +secrets, the agent is expected to save the new secrets to persistent +storage (if the secret's flags include AGENT_OWNED) as NetworkManager will +not send these secrets back to the same agent via a SaveSecrets() call. If +the user canceled any interaction, the agent should return the +UserCanceled error (see below). IN a{sa{sv}} connection: - Nested settings maps containing the connection for which secrets are being requested. This may contain system-owned secrets if the agent has successfully authenticated to modify system network settings and the GetSecrets request flags allow user interaction. + +Nested settings maps containing the connection for which secrets are being requested. This may contain system-owned secrets if the agent has successfully authenticated to modify system network settings and the GetSecrets request flags allow user interaction. + IN o connection_path: - Object path of the connection for which secrets are being requested. + +Object path of the connection for which secrets are being requested. + IN s setting_name: - Setting name for which secrets are being requested. + +Setting name for which secrets are being requested. + IN as hints: - Array of strings of key names in the requested setting for which NetworkManager thinks a secrets may be required, and/or well-known identifiers and data that may be useful to the client in processing the secrets request. Note that it's not always possible to determine which secret is required, so in some cases no hints may be given. The Agent should return any secrets it has, or that it thinks are required, regardless of what hints NetworkManager sends in this request. Some hints have special prefixes that provide information to the agent; for example, VPN requests may send server-specific messages prefixed with "x-vpn-message:". + +Array of strings of key names in the requested setting for which NetworkManager thinks a secrets may be required, and/or well-known identifiers and data that may be useful to the client in processing the secrets request. Note that it's not always possible to determine which secret is required, so in some cases no hints may be given. The Agent should return any secrets it has, or that it thinks are required, regardless of what hints NetworkManager sends in this request. Some hints have special prefixes that provide information to the agent; for example, VPN requests may send server-specific messages prefixed with "x-vpn-message:". + IN u flags: - (NMSecretAgentGetSecretsFlags) Flags which modify the behavior of the secrets request. If true, new secrets are assumed to be invalid or incorrect, and the agent should ask the user for new secrets. If false, existing secrets should be retrieved from storage and returned without interrupting the user. + +(NMSecretAgentGetSecretsFlags) Flags which modify the behavior of the secrets request. If true, new secrets are assumed to be invalid or incorrect, and the agent should ask the user for new secrets. If false, existing secrets should be retrieved from storage and returned without interrupting the user. + OUT a{sa{sv}} secrets: - Nested settings maps containing secrets. Each setting MUST contain at least the 'name' field, containing the name of the setting, and one or more secrets. + +Nested settings maps containing secrets. Each setting MUST contain at least the 'name' field, containing the name of the setting, and one or more secrets. + @@ -90,18 +104,23 @@ GetSecrets (IN a{sa{sv}} connection, CancelGetSecrets (IN o connection_path, IN s setting_name); - Cancel a pending GetSecrets request for secrets of the given connection. - Any GetSecrets request with the same 'connection_path' and 'setting_name' - that are given in a CancelGetSecrets request should be canceled. + +Cancel a pending GetSecrets request for secrets of the given connection. +Any GetSecrets request with the same 'connection_path' and 'setting_name' +that are given in a CancelGetSecrets request should be canceled. IN o connection_path: - Object path of the connection for which, if secrets for the given 'setting_name' are being requested, the request should be canceled. + +Object path of the connection for which, if secrets for the given 'setting_name' are being requested, the request should be canceled. + IN s setting_name: - Setting name for which secrets for this connection were originally being requested. + +Setting name for which secrets for this connection were originally being requested. + @@ -112,16 +131,21 @@ CancelGetSecrets (IN o connection_path, SaveSecrets (IN a{sa{sv}} connection, IN o connection_path); - Save given secrets to backing storage. + +Save given secrets to backing storage. IN a{sa{sv}} connection: - Nested settings maps containing the entire connection (including secrets), for which the agent should save the secrets to backing storage. This method will not be called when the agent itself is the process creating or updating a connection; in that case the agent is assumed to have already saved those secrets since it had them already. + +Nested settings maps containing the entire connection (including secrets), for which the agent should save the secrets to backing storage. This method will not be called when the agent itself is the process creating or updating a connection; in that case the agent is assumed to have already saved those secrets since it had them already. + IN o connection_path: - Object path of the connection for which the agent should save secrets to backing storage. + +Object path of the connection for which the agent should save secrets to backing storage. + @@ -132,16 +156,21 @@ SaveSecrets (IN a{sa{sv}} connection, DeleteSecrets (IN a{sa{sv}} connection, IN o connection_path); - Delete secrets from backing storage. + +Delete secrets from backing storage. IN a{sa{sv}} connection: - Nested settings maps containing the connection properties (sans secrets), for which the agent should delete the secrets from backing storage. + +Nested settings maps containing the connection properties (sans secrets), for which the agent should delete the secrets from backing storage. + IN o connection_path: - Object path of the connection for which the agent should delete secrets from backing storage. + +Object path of the connection for which the agent should delete secrets from backing storage. + diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml index d7648152..bdd3c2a4 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml @@ -39,7 +39,8 @@ Description - Represents a single network connection configuration. + +Represents a single network connection configuration. @@ -50,16 +51,19 @@ Update (IN a{sa{sv}} properties); - Update the connection with new settings and properties (replacing all - previous settings and properties) and save the connection to disk. Secrets - may be part of the update request, and will be either stored in persistent - storage or sent to a Secret Agent for storage, depending on the flags - associated with each secret. + +Update the connection with new settings and properties (replacing all +previous settings and properties) and save the connection to disk. Secrets +may be part of the update request, and will be either stored in persistent +storage or sent to a Secret Agent for storage, depending on the flags +associated with each secret. IN a{sa{sv}} properties: - New connection settings, properties, and (optionally) secrets. + +New connection settings, properties, and (optionally) secrets. + @@ -69,19 +73,22 @@ Update (IN a{sa{sv}} properties); UpdateUnsaved (IN a{sa{sv}} properties); - Update the connection with new settings and properties (replacing all - previous settings and properties) but do not immediately save the - connection to disk. Secrets may be part of the update request and may sent - to a Secret Agent for storage, depending on the flags associated with each - secret. Use the 'Save' method to save these changes to disk. Note that - unsaved changes will be lost if the connection is reloaded from disk - (either automatically on file change or due to an explicit - ReloadConnections call). + +Update the connection with new settings and properties (replacing all +previous settings and properties) but do not immediately save the +connection to disk. Secrets may be part of the update request and may sent +to a Secret Agent for storage, depending on the flags associated with each +secret. Use the 'Save' method to save these changes to disk. Note that +unsaved changes will be lost if the connection is reloaded from disk +(either automatically on file change or due to an explicit +ReloadConnections call). IN a{sa{sv}} properties: - New connection settings, properties, and (optionally) secrets. + +New connection settings, properties, and (optionally) secrets. + @@ -91,7 +98,8 @@ UpdateUnsaved (IN a{sa{sv}} properties); Delete (); - Delete the connection. + +Delete the connection. @@ -100,15 +108,18 @@ Delete (); GetSettings (OUT a{sa{sv}} settings); - Get the settings maps describing this network configuration. This will - never include any secrets required for connection to the network, as those - are often protected. Secrets must be requested separately using the - GetSecrets() call. + +Get the settings maps describing this network configuration. This will +never include any secrets required for connection to the network, as those +are often protected. Secrets must be requested separately using the +GetSecrets() call. OUT a{sa{sv}} settings: - The nested settings maps describing this object. + +The nested settings maps describing this object. + @@ -119,19 +130,24 @@ GetSettings (OUT a{sa{sv}} settings); GetSecrets (IN s setting_name, OUT a{sa{sv}} secrets); - Get the secrets belonging to this network configuration. Only secrets from - persistent storage or a Secret Agent running in the requestor's session - will be returned. The user will never be prompted for secrets as a result - of this request. + +Get the secrets belonging to this network configuration. Only secrets from +persistent storage or a Secret Agent running in the requestor's session +will be returned. The user will never be prompted for secrets as a result +of this request. IN s setting_name: - Name of the setting to return secrets for. If empty, all secrets will be returned. + +Name of the setting to return secrets for. If empty, all secrets will be returned. + OUT a{sa{sv}} secrets: - Nested settings maps containing secrets. + +Nested settings maps containing secrets. + @@ -141,7 +157,8 @@ GetSecrets (IN s setting_name, ClearSecrets (); - Clear the secrets belonging to this network connection profile. + +Clear the secrets belonging to this network connection profile. @@ -150,8 +167,9 @@ ClearSecrets (); Save (); - Saves a "dirty" connection (that had previously been updated with - UpdateUnsaved) to persistent storage. + +Saves a "dirty" connection (that had previously been updated with +UpdateUnsaved) to persistent storage. @@ -163,78 +181,93 @@ Update2 (IN a{sa{sv}} settings, IN a{sv} args, OUT a{sv} result); - Update the connection with new settings and properties (replacing all - previous settings and properties). - Update2 is an alternative to - Update, - UpdateUnsaved - and Save - extensible with extra flags and args arguments. - The flags argument accepts the combination of following values, - logically or-ed together: - - - 0x1 (to-disk): - The connection is persisted to disk. - - - 0x2 (in-memory): - The change is only made in memory (without touching an eventual - profile on disk). If neither 0x1 nor 0x2 is set, the change is made in memory - only, if the connection is already in memory only. - - - 0x4 (in-memory-detached): - Like "in-memory", but behaves slightly different when migrating - the profile from disk to in-memory. - - - 0x8 (in-memory-only): - Like "in-memory", but behaves slightly different when migrating - the profile from disk to in-memory. - - - 0x10 (volatile): - - - 0x20 (block-autoconnect): - Blocks auto-connect on the updated profile - - - 0x40 (no-reapply): - Prevents "connection.zone" and "connection.metered" properties - to take effect on currently active devices. - - - The args argument accepts the following keys: - - - plugin: - The settings plugin the connection will be migrated to - such as "keyfile" or "ifcfg-rh". - Since 1.38 - - - Secrets may be part of the update request, and will be either stored in persistent - storage or sent to a Secret Agent for storage, depending on the flags - associated with each secret. + +Update the connection with new settings and properties (replacing all +previous settings and properties). + +Update2 is an alternative to +Update, +UpdateUnsaved +and Save +extensible with extra flags and args arguments. + +The flags argument accepts the combination of following values, +logically or-ed together: + + + +0x1 (to-disk): +The connection is persisted to disk. + + +0x2 (in-memory): +The change is only made in memory (without touching an eventual +profile on disk). If neither 0x1 nor 0x2 is set, the change is made in memory +only, if the connection is already in memory only. + + +0x4 (in-memory-detached): +Like "in-memory", but behaves slightly different when migrating +the profile from disk to in-memory. + + +0x8 (in-memory-only): +Like "in-memory", but behaves slightly different when migrating +the profile from disk to in-memory. + + +0x10 (volatile): + + +0x20 (block-autoconnect): +Blocks auto-connect on the updated profile + + +0x40 (no-reapply): +Prevents "connection.zone" and "connection.metered" properties +to take effect on currently active devices. + + + +The args argument accepts the following keys: + + + +plugin: +The settings plugin the connection will be migrated to +such as "keyfile" or "ifcfg-rh". +Since 1.38 + + + +Secrets may be part of the update request, and will be either stored in persistent +storage or sent to a Secret Agent for storage, depending on the flags +associated with each secret. IN a{sa{sv}} settings: - New connection settings, properties, and (optionally) secrets. Provide an empty array to use the current settings. + +New connection settings, properties, and (optionally) secrets. Provide an empty array to use the current settings. + IN u flags: - Optional flags. Unknown flags cause the call to fail. + +Optional flags. Unknown flags cause the call to fail. + IN a{sv} args: - Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail. + +Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail. + OUT a{sv} result: - Currently no results are returned. + +Currently no results are returned. + Since 1.12 @@ -248,10 +281,11 @@ Update2 (IN a{sa{sv}} settings, Updated (); - Emitted when any settings or permissions change. When handling this - signal, clients should re-read the connection using the GetSettings method - to get the changes and to ensure the client still has permission to access - the connection. + +Emitted when any settings or permissions change. When handling this +signal, clients should re-read the connection using the GetSettings method +to get the changes and to ensure the client still has permission to access +the connection. @@ -260,10 +294,11 @@ Updated (); Removed (); - Emitted when this connection is no longer available. This happens when the - connection is deleted or if it is no longer accessible by any of the - system's logged-in users. After receipt of this signal, the object no - longer exists. Also see the Settings.ConnectionRemoved signal. + +Emitted when this connection is no longer available. This happens when the +connection is deleted or if it is no longer accessible by any of the +system's logged-in users. After receipt of this signal, the object no +longer exists. Also see the Settings.ConnectionRemoved signal. @@ -275,10 +310,11 @@ Removed (); Unsaved readable b - If set, indicates that the in-memory state of the connection does not - match the on-disk state. This flag will be set when UpdateUnsaved() is - called or when any connection details change, and cleared when the - connection is saved to disk via Save() or from internal operations. + +If set, indicates that the in-memory state of the connection does not +match the on-disk state. This flag will be set when UpdateUnsaved() is +called or when any connection details change, and cleared when the +connection is saved to disk via Save() or from internal operations. @@ -287,8 +323,10 @@ Unsaved readable b Flags readable u - Additional flags of the connection profile. - Returns: NMSettingsConnectionFlags + +Additional flags of the connection profile. + +Returns: NMSettingsConnectionFlags Since 1.12 @@ -298,7 +336,8 @@ Flags readable u Filename readable s - File that stores the connection in case the connection is file-backed. + +File that stores the connection in case the connection is file-backed. Since 1.12 diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Settings.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Settings.xml index 3dfc50e1..b501ea69 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Settings.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Settings.xml @@ -44,8 +44,9 @@ Description - The Settings interface allows clients to view and administrate the - connections stored and used by NetworkManager. + +The Settings interface allows clients to view and administrate the +connections stored and used by NetworkManager. @@ -56,12 +57,15 @@ ListConnections (OUT ao connections); - List the saved network connections known to NetworkManager. + +List the saved network connections known to NetworkManager. OUT ao connections: - List of connections. + +List of connections. + @@ -72,16 +76,21 @@ ListConnections (OUT ao connections); GetConnectionByUuid (IN s uuid, OUT o connection); - Retrieve the object path of a connection, given that connection's UUID. + +Retrieve the object path of a connection, given that connection's UUID. IN s uuid: - The UUID to find the connection object path for. + +The UUID to find the connection object path for. + OUT o connection: - The connection's object path. + +The connection's object path. + @@ -92,19 +101,24 @@ GetConnectionByUuid (IN s uuid, AddConnection (IN a{sa{sv}} connection, OUT o path); - Add new connection and save it to disk. This operation does not start the - network connection unless (1) device is idle and able to connect to the - network described by the new connection, and (2) the connection is allowed - to be started automatically. + +Add new connection and save it to disk. This operation does not start the +network connection unless (1) device is idle and able to connect to the +network described by the new connection, and (2) the connection is allowed +to be started automatically. IN a{sa{sv}} connection: - Connection settings and properties. + +Connection settings and properties. + OUT o path: - Object path of the new connection that was just added. + +Object path of the new connection that was just added. + @@ -115,20 +129,25 @@ AddConnection (IN a{sa{sv}} connection, AddConnectionUnsaved (IN a{sa{sv}} connection, OUT o path); - Add new connection but do not save it to disk immediately. This operation - does not start the network connection unless (1) device is idle and able - to connect to the network described by the new connection, and (2) the - connection is allowed to be started automatically. Use the 'Save' method - on the connection to save these changes to disk. + +Add new connection but do not save it to disk immediately. This operation +does not start the network connection unless (1) device is idle and able +to connect to the network described by the new connection, and (2) the +connection is allowed to be started automatically. Use the 'Save' method +on the connection to save these changes to disk. IN a{sa{sv}} connection: - Connection settings and properties. + +Connection settings and properties. + OUT o path: - Object path of the new connection that was just added. + +Object path of the new connection that was just added. + @@ -142,64 +161,81 @@ AddConnection2 (IN a{sa{sv}} settings, OUT o path, OUT a{sv} result); - Add a new connection profile. - AddConnection2 is an alternative to - AddConnection and - AddConnectionUnsaved. - The new variant can do everything that the older variants could, and more. - Its behavior is extensible via extra flags and args arguments. - The flags argument accepts the combination of following values, - logically or-ed together: - - - 0x1 (to-disk): - The connection is persisted to disk. - - - 0x2 (in-memory): - The change is only made in memory (without touching an eventual - profile on disk). If neither 0x1 nor 0x2 is set, the change is made in memory - only, if the connection is already in memory only. - - - 0x20 (block-autoconnect): - Blocks auto-connect on the new profile - - - The args argument accepts the following keys: - - - plugin: - The settings plugin the newly added connection will - use, such as "keyfile" or "ifcfg-rh". - Since 1.38 - - - Either the flags 0x1 (to-disk) or 0x2 (in-memory) must be specified. - The effect is whether to behave like - AddConnection or - AddConnectionUnsaved. + +Add a new connection profile. + +AddConnection2 is an alternative to +AddConnection and +AddConnectionUnsaved. +The new variant can do everything that the older variants could, and more. +Its behavior is extensible via extra flags and args arguments. + +The flags argument accepts the combination of following values, +logically or-ed together: + + + +0x1 (to-disk): +The connection is persisted to disk. + + +0x2 (in-memory): +The change is only made in memory (without touching an eventual +profile on disk). If neither 0x1 nor 0x2 is set, the change is made in memory +only, if the connection is already in memory only. + + +0x20 (block-autoconnect): +Blocks auto-connect on the new profile + + + +The args argument accepts the following keys: + + + +plugin: +The settings plugin the newly added connection will +use, such as "keyfile" or "ifcfg-rh". +Since 1.38 + + + +Either the flags 0x1 (to-disk) or 0x2 (in-memory) must be specified. +The effect is whether to behave like +AddConnection or +AddConnectionUnsaved. IN a{sa{sv}} settings: - New connection settings, properties, and (optionally) secrets. + +New connection settings, properties, and (optionally) secrets. + IN u flags: - Flags. Unknown flags cause the call to fail. + +Flags. Unknown flags cause the call to fail. + IN a{sv} args: - Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail. + +Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail. + OUT o path: - Object path of the new connection that was just added. + +Object path of the new connection that was just added. + OUT a{sv} result: - Output argument, currently no additional results are returned. + +Output argument, currently no additional results are returned. + Since 1.20 @@ -212,27 +248,35 @@ LoadConnections (IN as filenames, OUT b status, OUT as failures); - Loads or reloads the indicated connections from disk. You should call this - after making changes directly to an on-disk connection file to make sure - that NetworkManager sees the changes. - As with AddConnection(), this operation does not necessarily - start the network connection. - Note that before 1.20, NetworkManager had a bug and this status value was wrong. - It is better to assume success if the method does not return with a D-Bus error. - On top of that, you can look at failures to know whether any of the requested files failed. + +Loads or reloads the indicated connections from disk. You should call this +after making changes directly to an on-disk connection file to make sure +that NetworkManager sees the changes. +As with AddConnection(), this operation does not necessarily +start the network connection. + +Note that before 1.20, NetworkManager had a bug and this status value was wrong. +It is better to assume success if the method does not return with a D-Bus error. +On top of that, you can look at failures to know whether any of the requested files failed. IN as filenames: - Array of paths to on-disk connection profiles in directories monitored by NetworkManager. + +Array of paths to on-disk connection profiles in directories monitored by NetworkManager. + OUT b status: - Success or failure of the operation as a whole. True if NetworkManager at least tried to load the indicated connections, even if it did not succeed. False if an error occurred before trying to load the connections (eg, permission denied). + +Success or failure of the operation as a whole. True if NetworkManager at least tried to load the indicated connections, even if it did not succeed. False if an error occurred before trying to load the connections (eg, permission denied). + OUT as failures: - Paths of connection files that could not be loaded. + +Paths of connection files that could not be loaded. + @@ -242,13 +286,16 @@ LoadConnections (IN as filenames, ReloadConnections (OUT b status); - Tells NetworkManager to reload all connection files from disk, including - noticing any added or deleted connection files. + +Tells NetworkManager to reload all connection files from disk, including +noticing any added or deleted connection files. OUT b status: - This always returns TRUE. + +This always returns TRUE. + @@ -258,12 +305,15 @@ ReloadConnections (OUT b status); SaveHostname (IN s hostname); - Save the hostname to persistent configuration. + +Save the hostname to persistent configuration. IN s hostname: - The hostname to save to persistent configuration. If blank, the persistent hostname is cleared. + +The hostname to save to persistent configuration. If blank, the persistent hostname is cleared. + @@ -276,19 +326,22 @@ SaveHostname (IN s hostname); NewConnection (o connection); - Emitted when a new connection has been added after NetworkManager has - started up and initialized. This signal is not emitted for connections - read while starting up, because NetworkManager's D-Bus service is only - available after all connections have been read, and to prevent spamming - listeners with too many signals at one time. To retrieve the initial - connection list, call the ListConnections() method once, and then listen - for individual Settings.NewConnection and Settings.Connection.Deleted - signals for further updates. + +Emitted when a new connection has been added after NetworkManager has +started up and initialized. This signal is not emitted for connections +read while starting up, because NetworkManager's D-Bus service is only +available after all connections have been read, and to prevent spamming +listeners with too many signals at one time. To retrieve the initial +connection list, call the ListConnections() method once, and then listen +for individual Settings.NewConnection and Settings.Connection.Deleted +signals for further updates. o connection: - Object path of the new connection. + +Object path of the new connection. + @@ -298,16 +351,19 @@ NewConnection (o connection); ConnectionRemoved (o connection); - Emitted when a connection is no longer available. This happens when the - connection is deleted or if it is no longer accessible by any of the - system's logged-in users. After receipt of this signal, the connection no - longer exists and cannot be used. Also see the Settings.Connection.Removed - signal. + +Emitted when a connection is no longer available. This happens when the +connection is deleted or if it is no longer accessible by any of the +system's logged-in users. After receipt of this signal, the connection no +longer exists and cannot be used. Also see the Settings.Connection.Removed +signal. o connection: - Object path of the removed connection. + +Object path of the removed connection. + @@ -320,7 +376,8 @@ ConnectionRemoved (o connection); Connections readable ao - List of object paths of available network connection profiles. + +List of object paths of available network connection profiles. @@ -329,7 +386,8 @@ Connections readable ao Hostname readable s - The machine hostname stored in persistent configuration. + +The machine hostname stored in persistent configuration. @@ -338,7 +396,8 @@ Hostname readable s CanModify readable b - If true, adding and modifying connections is supported. + +If true, adding and modifying connections is supported. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.VPN.Connection.xml b/docs/api/dbus-org.freedesktop.NetworkManager.VPN.Connection.xml index 1ba37bf2..6a23fae4 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.VPN.Connection.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.VPN.Connection.xml @@ -21,7 +21,8 @@ Description - Represents an active connection to a Virtual Private Network. + +Represents an active connection to a Virtual Private Network. @@ -33,16 +34,21 @@ VpnStateChanged (u state, u reason); - Emitted when the state of the VPN connection has changed. + +Emitted when the state of the VPN connection has changed. u state: - (NMVpnConnectionState) The new state of the VPN connection. + +(NMVpnConnectionState) The new state of the VPN connection. + u reason: - (NMActiveConnectionStateReason) Reason code describing the change to the new state. + +(NMActiveConnectionStateReason) Reason code describing the change to the new state. + @@ -55,8 +61,10 @@ VpnStateChanged (u state, VpnState readable u - The VPN-specific state of the connection. - Returns: NMVpnConnectionState + +The VPN-specific state of the connection. + +Returns: NMVpnConnectionState @@ -65,7 +73,8 @@ VpnState readable u Banner readable s - The banner string of the VPN connection. + +The banner string of the VPN connection. diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.VPN.Plugin.xml b/docs/api/dbus-org.freedesktop.NetworkManager.VPN.Plugin.xml index 5604099d..0efccfe7 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.VPN.Plugin.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.VPN.Plugin.xml @@ -42,8 +42,9 @@ Description - This interface is provided by plugins providing VPN services to the - NetworkManager daemon. + +This interface is provided by plugins providing VPN services to the +NetworkManager daemon. @@ -54,13 +55,16 @@ Connect (IN a{sa{sv}} connection); - Tells the plugin to connect. Interactive secrets requests (eg, emitting - the SecretsRequired signal) are not allowed. + +Tells the plugin to connect. Interactive secrets requests (eg, emitting +the SecretsRequired signal) are not allowed. IN a{sa{sv}} connection: - Describes the connection to be established. + +Describes the connection to be established. + @@ -71,18 +75,23 @@ Connect (IN a{sa{sv}} connection); ConnectInteractive (IN a{sa{sv}} connection, IN a{sv} details); - Tells the plugin to connect, allowing interactive secrets requests (eg the - plugin is allowed to emit the SecretsRequired signal if the VPN service - indicates that it needs additional secrets during the connect process). + +Tells the plugin to connect, allowing interactive secrets requests (eg the +plugin is allowed to emit the SecretsRequired signal if the VPN service +indicates that it needs additional secrets during the connect process). IN a{sa{sv}} connection: - Describes the connection to be established. + +Describes the connection to be established. + IN a{sv} details: - Additional details about the Connect process. + +Additional details about the Connect process. + @@ -93,17 +102,22 @@ ConnectInteractive (IN a{sa{sv}} connection, NeedSecrets (IN a{sa{sv}} settings, OUT s setting_name); - Asks the plugin whether the provided connection will require secrets to - connect successfully. + +Asks the plugin whether the provided connection will require secrets to +connect successfully. IN a{sa{sv}} settings: - Describes the connection that may need secrets. + +Describes the connection that may need secrets. + OUT s setting_name: - The setting name within the provided connection that requires secrets, if any. + +The setting name within the provided connection that requires secrets, if any. + @@ -113,7 +127,8 @@ NeedSecrets (IN a{sa{sv}} settings, Disconnect (); - Disconnect the plugin. + +Disconnect the plugin. @@ -122,12 +137,15 @@ Disconnect (); SetConfig (IN a{sv} config); - Set generic connection details on the connection. + +Set generic connection details on the connection. IN a{sv} config: - Generic configuration details for the connection. + +Generic configuration details for the connection. + @@ -137,12 +155,15 @@ SetConfig (IN a{sv} config); SetIp4Config (IN a{sv} config); - Set IPv4 details on the connection. + +Set IPv4 details on the connection. IN a{sv} config: - Ip4Config details for the connection. You must call SetConfig() before calling this. + +Ip4Config details for the connection. You must call SetConfig() before calling this. + @@ -152,12 +173,15 @@ SetIp4Config (IN a{sv} config); SetIp6Config (IN a{sv} config); - Set IPv6 details on the connection. + +Set IPv6 details on the connection. IN a{sv} config: - Ip6Config details for the connection. You must call SetConfig() before calling this. + +Ip6Config details for the connection. You must call SetConfig() before calling this. + @@ -167,12 +191,15 @@ SetIp6Config (IN a{sv} config); SetFailure (IN s reason); - Indicate a failure to the plugin. + +Indicate a failure to the plugin. IN s reason: - The reason for the failure. + +The reason for the failure. + @@ -182,13 +209,16 @@ SetFailure (IN s reason); NewSecrets (IN a{sa{sv}} connection); - Called in response to a SecretsRequired signal to deliver updated secrets - or other information to the plugin. + +Called in response to a SecretsRequired signal to deliver updated secrets +or other information to the plugin. IN a{sa{sv}} connection: - Describes the connection including the new secrets. + +Describes the connection including the new secrets. + @@ -201,12 +231,15 @@ NewSecrets (IN a{sa{sv}} connection); StateChanged (u state); - Emitted when the plugin state changes. + +Emitted when the plugin state changes. u state: - (NMVpnServiceState) The new state of the plugin. + +(NMVpnServiceState) The new state of the plugin. + @@ -217,18 +250,23 @@ StateChanged (u state); SecretsRequired (s message, as secrets); - Emitted during an ongoing ConnectInteractive() request when the plugin has - determined that new secrets are required. NetworkManager will then call - the NewSecrets() method with a connection hash including the new secrets. + +Emitted during an ongoing ConnectInteractive() request when the plugin has +determined that new secrets are required. NetworkManager will then call +the NewSecrets() method with a connection hash including the new secrets. s message: - Informational message, if any, about the request. For example, if a second PIN is required, could indicate to the user to wait for the token code to change until entering the next PIN. + +Informational message, if any, about the request. For example, if a second PIN is required, could indicate to the user to wait for the token code to change until entering the next PIN. + as secrets: - Array of strings of VPN secret names which the plugin thinks secrets may be required for, or other VPN-specific data to be processed by the VPN's front-end. + +Array of strings of VPN secret names which the plugin thinks secrets may be required for, or other VPN-specific data to be processed by the VPN's front-end. + @@ -238,12 +276,15 @@ SecretsRequired (s message, Config (a{sv} config); - The plugin obtained generic configuration information. + +The plugin obtained generic configuration information. a{sv} config: - The configuration information. + +The configuration information. + @@ -253,12 +294,15 @@ Config (a{sv} config); Ip4Config (a{sv} ip4config); - The plugin obtained an IPv4 configuration. + +The plugin obtained an IPv4 configuration. a{sv} ip4config: - The IPv4 configuration. + +The IPv4 configuration. + @@ -268,12 +312,15 @@ Ip4Config (a{sv} ip4config); Ip6Config (a{sv} ip6config); - The plugin obtained an IPv6 configuration. + +The plugin obtained an IPv6 configuration. a{sv} ip6config: - The IPv6 configuration. + +The IPv6 configuration. + @@ -283,12 +330,15 @@ Ip6Config (a{sv} ip6config); LoginBanner (s banner); - Emitted when the plugin receives a login banner from the VPN service. + +Emitted when the plugin receives a login banner from the VPN service. s banner: - The login banner string. + +The login banner string. + @@ -298,12 +348,15 @@ LoginBanner (s banner); Failure (u reason); - Emitted when a failure in the VPN plugin occurs. + +Emitted when a failure in the VPN plugin occurs. u reason: - (NMVpnPluginFailure) Reason code for the failure. + +(NMVpnPluginFailure) Reason code for the failure. + @@ -316,8 +369,10 @@ Failure (u reason); State readable u - The state of the plugin. - Returns: NMVpnServiceState + +The state of the plugin. + +Returns: NMVpnServiceState diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.xml b/docs/api/dbus-org.freedesktop.NetworkManager.xml index 89664bbc..31d0ad28 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.xml @@ -91,7 +91,9 @@ Description - + + + Method Details @@ -101,30 +103,34 @@ Reload (IN u flags); - Reload NetworkManager's configuration and perform certain updates, like flushing a cache or - rewriting external state to disk. This is similar to sending SIGHUP to NetworkManager but it - allows for more fine-grained control over what to reload (see flags). It also allows - non-root access via PolicyKit and contrary to signals it is synchronous. - No flags (0x00) means to reload everything that is supported which is identical to - sending a SIGHUP. - (0x01) means to reload the NetworkManager.conf configuration from disk. Note that this - does not include connections, which can be reloaded via Setting's ReloadConnections. - (0x02) means to update DNS configuration, which usually involves writing /etc/resolv.conf - anew. - (0x04) means to restart the DNS plugin. This is for example useful when using - dnsmasq plugin, which uses additional configuration in /etc/NetworkManager/dnsmasq.d. - If you edit those files, you can restart the DNS plugin. This action shortly interrupts - name resolution. - Note that flags may affect each other. For example, restarting the DNS plugin (0x04) - implicitly updates DNS too (0x02). Or when reloading the configuration (0x01), changes - to DNS setting also cause a DNS update (0x02). However, (0x01) does not involve restarting - the DNS plugin (0x04) or update resolv.conf (0x02), unless the DNS related configuration - changes in NetworkManager.conf. + +Reload NetworkManager's configuration and perform certain updates, like flushing a cache or +rewriting external state to disk. This is similar to sending SIGHUP to NetworkManager but it +allows for more fine-grained control over what to reload (see flags). It also allows +non-root access via PolicyKit and contrary to signals it is synchronous. + +No flags (0x00) means to reload everything that is supported which is identical to +sending a SIGHUP. +(0x01) means to reload the NetworkManager.conf configuration from disk. Note that this +does not include connections, which can be reloaded via Setting's ReloadConnections. +(0x02) means to update DNS configuration, which usually involves writing /etc/resolv.conf +anew. +(0x04) means to restart the DNS plugin. This is for example useful when using +dnsmasq plugin, which uses additional configuration in /etc/NetworkManager/dnsmasq.d. +If you edit those files, you can restart the DNS plugin. This action shortly interrupts +name resolution. +Note that flags may affect each other. For example, restarting the DNS plugin (0x04) +implicitly updates DNS too (0x02). Or when reloading the configuration (0x01), changes +to DNS setting also cause a DNS update (0x02). However, (0x01) does not involve restarting +the DNS plugin (0x04) or update resolv.conf (0x02), unless the DNS related configuration +changes in NetworkManager.conf. IN u flags: - Optional flags to specify which parts shall be reloaded. + +Optional flags to specify which parts shall be reloaded. + @@ -134,12 +140,15 @@ Reload (IN u flags); GetDevices (OUT ao devices); - Get the list of realized network devices. + +Get the list of realized network devices. OUT ao devices: - List of object paths of network devices known to the system. This list does not include device placeholders (see GetAllDevices()). + +List of object paths of network devices known to the system. This list does not include device placeholders (see GetAllDevices()). + @@ -149,12 +158,15 @@ GetDevices (OUT ao devices); GetAllDevices (OUT ao devices); - Get the list of all network devices. + +Get the list of all network devices. OUT ao devices: - List of object paths of network devices and device placeholders (eg, devices that do not yet exist but which can be automatically created by NetworkManager if one of their AvailableConnections was activated). + +List of object paths of network devices and device placeholders (eg, devices that do not yet exist but which can be automatically created by NetworkManager if one of their AvailableConnections was activated). + @@ -165,18 +177,23 @@ GetAllDevices (OUT ao devices); GetDeviceByIpIface (IN s iface, OUT o device); - Return the object path of the network device referenced by its IP - interface name. Note that some devices (usually modems) only have an IP - interface name when they are connected. + +Return the object path of the network device referenced by its IP +interface name. Note that some devices (usually modems) only have an IP +interface name when they are connected. IN s iface: - Interface name of the device to find. + +Interface name of the device to find. + OUT o device: - Object path of the network device. + +Object path of the network device. + @@ -189,24 +206,33 @@ ActivateConnection (IN o connection, IN o specific_object, OUT o active_connection); - Activate a connection using the supplied device. + +Activate a connection using the supplied device. IN o connection: - The connection to activate. If "/" is given, a valid device path must be given, and NetworkManager picks the best connection to activate for the given device. VPN connections must always pass a valid connection path. + +The connection to activate. If "/" is given, a valid device path must be given, and NetworkManager picks the best connection to activate for the given device. VPN connections must always pass a valid connection path. + IN o device: - The object path of device to be activated for physical connections. This parameter is ignored for VPN connections, because the specific_object (if provided) specifies the device to use. + +The object path of device to be activated for physical connections. This parameter is ignored for VPN connections, because the specific_object (if provided) specifies the device to use. + IN o specific_object: - The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For Wi-Fi connections, pass the object path of a specific AP from the card's scan list, or "/" to pick an AP automatically. For VPN connections, pass the object path of an ActiveConnection object that should serve as the "base" connection (to which the VPN connections lifetime will be tied), or pass "/" and NM will automatically use the current default device. + +The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For Wi-Fi connections, pass the object path of a specific AP from the card's scan list, or "/" to pick an AP automatically. For VPN connections, pass the object path of an ActiveConnection object that should serve as the "base" connection (to which the VPN connections lifetime will be tied), or pass "/" and NM will automatically use the current default device. + OUT o active_connection: - The path of the active connection object representing this active connection. + +The path of the active connection object representing this active connection. + @@ -220,32 +246,44 @@ AddAndActivateConnection (IN a{sa{sv}} connection, OUT o path, OUT o active_connection); - Adds a new connection using the given details (if any) as a template - (automatically filling in missing settings with the capabilities of the - given device and specific object), then activate the new connection. - Cannot be used for VPN connections at this time. - See also AddAndActivateConnection2. + +Adds a new connection using the given details (if any) as a template +(automatically filling in missing settings with the capabilities of the +given device and specific object), then activate the new connection. +Cannot be used for VPN connections at this time. + +See also AddAndActivateConnection2. IN a{sa{sv}} connection: - Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object. + +Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object. + IN o device: - The object path of device to be activated using the given connection. + +The object path of device to be activated using the given connection. + IN o specific_object: - The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For Wi-Fi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection. + +The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For Wi-Fi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection. + OUT o path: - Object path of the new connection that was just added. + +Object path of the new connection that was just added. + OUT o active_connection: - The path of the active connection object representing this active connection. + +The path of the active connection object representing this active connection. + @@ -261,43 +299,60 @@ AddAndActivateConnection2 (IN a{sa{sv}} connection, OUT o active_connection, OUT a{sv} result); - Adds a new connection using the given details (if any) as a template - (automatically filling in missing settings with the capabilities of the - given device and specific object), then activate the new connection. - Cannot be used for VPN connections at this time. - This method extends AddAndActivateConnection to allow passing further - parameters. At this time the following options are supported: - * persist: A string value of either "disk" (default), "memory" or "volatile". If "memory" is passed, the connection will not be saved to disk. If "volatile" is passed, the connection will not be saved to disk and will be destroyed when disconnected. - * bind-activation: Bind the activation lifetime. Set to "dbus-name" to automatically disconnect when the requesting process disappears from the bus. The default of "none" means the connection is kept activated normally. + +Adds a new connection using the given details (if any) as a template +(automatically filling in missing settings with the capabilities of the +given device and specific object), then activate the new connection. +Cannot be used for VPN connections at this time. + +This method extends AddAndActivateConnection to allow passing further +parameters. At this time the following options are supported: + +* persist: A string value of either "disk" (default), "memory" or "volatile". If "memory" is passed, the connection will not be saved to disk. If "volatile" is passed, the connection will not be saved to disk and will be destroyed when disconnected. +* bind-activation: Bind the activation lifetime. Set to "dbus-name" to automatically disconnect when the requesting process disappears from the bus. The default of "none" means the connection is kept activated normally. IN a{sa{sv}} connection: - Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object. + +Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object. + IN o device: - The object path of device to be activated using the given connection. + +The object path of device to be activated using the given connection. + IN o specific_object: - The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For Wi-Fi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection. + +The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For Wi-Fi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection. + IN a{sv} options: - Further options for the method call. + +Further options for the method call. + OUT o path: - Object path of the new connection that was just added. + +Object path of the new connection that was just added. + OUT o active_connection: - The path of the active connection object representing this active connection. + +The path of the active connection object representing this active connection. + OUT a{sv} result: - A dictionary of additional output arguments for future extension. Currently, not additional output arguments are supported. + +A dictionary of additional output arguments for future extension. Currently, not additional output arguments are supported. + @@ -307,12 +362,15 @@ AddAndActivateConnection2 (IN a{sa{sv}} connection, DeactivateConnection (IN o active_connection); - Deactivate an active connection. + +Deactivate an active connection. IN o active_connection: - The currently active connection to deactivate. + +The currently active connection to deactivate. + @@ -322,15 +380,18 @@ DeactivateConnection (IN o active_connection); Sleep (IN b sleep); - Control the NetworkManager daemon's sleep state. When asleep, all - interfaces that it manages are deactivated. When awake, devices are - available to be activated. This command should not be called directly by - users or clients; it is intended for system suspend/resume tracking. + +Control the NetworkManager daemon's sleep state. When asleep, all +interfaces that it manages are deactivated. When awake, devices are +available to be activated. This command should not be called directly by +users or clients; it is intended for system suspend/resume tracking. IN b sleep: - Indicates whether the NetworkManager daemon should sleep or wake. + +Indicates whether the NetworkManager daemon should sleep or wake. + @@ -340,16 +401,19 @@ Sleep (IN b sleep); Enable (IN b enable); - Control whether overall networking is enabled or disabled. When disabled, - all interfaces that NM manages are deactivated. When enabled, all managed - interfaces are re-enabled and available to be activated. This command - should be used by clients that provide to users the ability to - enable/disable all networking. + +Control whether overall networking is enabled or disabled. When disabled, +all interfaces that NM manages are deactivated. When enabled, all managed +interfaces are re-enabled and available to be activated. This command +should be used by clients that provide to users the ability to +enable/disable all networking. IN b enable: - If FALSE, indicates that all networking should be disabled. If TRUE, indicates that NetworkManager should begin managing network devices. + +If FALSE, indicates that all networking should be disabled. If TRUE, indicates that NetworkManager should begin managing network devices. + @@ -359,14 +423,17 @@ Enable (IN b enable); GetPermissions (OUT a{ss} permissions); - Returns the permissions a caller has for various authenticated operations - that NetworkManager provides, like Enable/Disable networking, changing - Wi-Fi, WWAN, and WiMAX state, etc. + +Returns the permissions a caller has for various authenticated operations +that NetworkManager provides, like Enable/Disable networking, changing +Wi-Fi, WWAN, and WiMAX state, etc. OUT a{ss} permissions: - Dictionary of available permissions and results. Each permission is represented by a name (ie "org.freedesktop.NetworkManager.Foobar") and each result is one of the following values: "yes" (the permission is available), "auth" (the permission is available after a successful authentication), or "no" (the permission is denied). Clients may use these values in the UI to indicate the ability to perform certain operations. + +Dictionary of available permissions and results. Each permission is represented by a name (ie "org.freedesktop.NetworkManager.Foobar") and each result is one of the following values: "yes" (the permission is available), "auth" (the permission is available after a successful authentication), or "no" (the permission is denied). Clients may use these values in the UI to indicate the ability to perform certain operations. + @@ -377,16 +444,21 @@ GetPermissions (OUT a{ss} permissions); SetLogging (IN s level, IN s domains); - Set logging verbosity and which operations are logged. + +Set logging verbosity and which operations are logged. IN s level: - One of [ERR, WARN, INFO, DEBUG, TRACE, OFF, KEEP]. This level is applied to the domains as specified in the domains argument. Except for the special level "KEEP", all unmentioned domains are disabled entirely. "KEEP" is special and allows not to change the current setting except for the specified domains. E.g. level=KEEP and domains=PLATFORM:DEBUG will only touch the platform domain. + +One of [ERR, WARN, INFO, DEBUG, TRACE, OFF, KEEP]. This level is applied to the domains as specified in the domains argument. Except for the special level "KEEP", all unmentioned domains are disabled entirely. "KEEP" is special and allows not to change the current setting except for the specified domains. E.g. level=KEEP and domains=PLATFORM:DEBUG will only touch the platform domain. + IN s domains: - A combination of logging domains separated by commas (','), or "NONE" to disable logging. Each domain enables logging for operations related to that domain. Available domains are: [PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, TEAM, CONCHECK, DCB, DISPATCH, AUDIT]. In addition to these domains, the following special domains can be used: [NONE, ALL, DEFAULT, DHCP, IP]. You can also specify that some domains should log at a different level from the default by appending a colon (':') and a log level (eg, 'WIFI:DEBUG'). If an empty string is given, the log level is changed but the current set of log domains remains unchanged. + +A combination of logging domains separated by commas (','), or "NONE" to disable logging. Each domain enables logging for operations related to that domain. Available domains are: [PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, TEAM, CONCHECK, DCB, DISPATCH, AUDIT]. In addition to these domains, the following special domains can be used: [NONE, ALL, DEFAULT, DHCP, IP]. You can also specify that some domains should log at a different level from the default by appending a colon (':') and a log level (eg, 'WIFI:DEBUG'). If an empty string is given, the log level is changed but the current set of log domains remains unchanged. + @@ -397,16 +469,21 @@ SetLogging (IN s level, GetLogging (OUT s level, OUT s domains); - Get current logging verbosity level and operations domains. + +Get current logging verbosity level and operations domains. OUT s level: - One of [ERR, WARN, INFO, DEBUG, TRACE]. + +One of [ERR, WARN, INFO, DEBUG, TRACE]. + OUT s domains: - For available domains see SetLogging() call. + +For available domains see SetLogging() call. + @@ -416,12 +493,15 @@ GetLogging (OUT s level, CheckConnectivity (OUT u connectivity); - Re-check the network connectivity state. + +Re-check the network connectivity state. OUT u connectivity: - (NMConnectivityState) The current connectivity state. + +(NMConnectivityState) The current connectivity state. + @@ -431,13 +511,16 @@ CheckConnectivity (OUT u connectivity); state (OUT u state); - The overall networking state as determined by the NetworkManager daemon, - based on the state of network devices under its management. + +The overall networking state as determined by the NetworkManager daemon, +based on the state of network devices under its management. OUT u state: - NMState + +NMState + @@ -450,26 +533,35 @@ CheckpointCreate (IN ao devices, IN u flags, OUT o checkpoint); - Create a checkpoint of the current networking configuration - for given interfaces. If rollback_timeout is not zero, a - rollback is automatically performed after the given timeout. + +Create a checkpoint of the current networking configuration +for given interfaces. If rollback_timeout is not zero, a +rollback is automatically performed after the given timeout. IN ao devices: - A list of device paths for which a checkpoint should be created. An empty list means all devices. + +A list of device paths for which a checkpoint should be created. An empty list means all devices. + IN u rollback_timeout: - The time in seconds until NetworkManager will automatically rollback to the checkpoint. Set to zero for infinite. + +The time in seconds until NetworkManager will automatically rollback to the checkpoint. Set to zero for infinite. + IN u flags: - (NMCheckpointCreateFlags) Flags for the creation. + +(NMCheckpointCreateFlags) Flags for the creation. + OUT o checkpoint: - On success, the path of the new checkpoint. + +On success, the path of the new checkpoint. + @@ -479,12 +571,15 @@ CheckpointCreate (IN ao devices, CheckpointDestroy (IN o checkpoint); - Destroy a previously created checkpoint. + +Destroy a previously created checkpoint. IN o checkpoint: - The checkpoint to be destroyed. Set to empty to cancel all pending checkpoints. + +The checkpoint to be destroyed. Set to empty to cancel all pending checkpoints. + @@ -495,16 +590,21 @@ CheckpointDestroy (IN o checkpoint); CheckpointRollback (IN o checkpoint, OUT a{su} result); - Rollback a checkpoint before the timeout is reached. + +Rollback a checkpoint before the timeout is reached. IN o checkpoint: - The checkpoint to be rolled back. + +The checkpoint to be rolled back. + OUT a{su} result: - On return, a dictionary of devices and results. Devices are represented by their original D-Bus path; each result is a RollbackResult. + +On return, a dictionary of devices and results. Devices are represented by their original D-Bus path; each result is a RollbackResult. + @@ -515,23 +615,29 @@ CheckpointRollback (IN o checkpoint, CheckpointAdjustRollbackTimeout (IN o checkpoint, IN u add_timeout); - Reset the timeout for rollback for the checkpoint. - Note that the added seconds start counting from now, - not "Created" timestamp or the previous expiration - time. Note that the "Created" property of the checkpoint - will stay unchanged by this call. However, the "RollbackTimeout" - will be recalculated to give the approximate new expiration time. - The new "RollbackTimeout" property will be approximate up to - one second precision, which is the accuracy of the property. + +Reset the timeout for rollback for the checkpoint. + +Note that the added seconds start counting from now, +not "Created" timestamp or the previous expiration +time. Note that the "Created" property of the checkpoint +will stay unchanged by this call. However, the "RollbackTimeout" +will be recalculated to give the approximate new expiration time. +The new "RollbackTimeout" property will be approximate up to +one second precision, which is the accuracy of the property. IN o checkpoint: - The checkpoint to be rolled back. + +The checkpoint to be rolled back. + IN u add_timeout: - Number of seconds from now in which the timeout will expire. Set to 0 to disable the timeout. + +Number of seconds from now in which the timeout will expire. Set to 0 to disable the timeout. + Since 1.12 @@ -545,8 +651,9 @@ CheckpointAdjustRollbackTimeout (IN o checkpoint, CheckPermissions (); - Emitted when system authorization details change, indicating that clients - may wish to recheck permissions with GetPermissions. + +Emitted when system authorization details change, indicating that clients +may wish to recheck permissions with GetPermissions. @@ -555,12 +662,15 @@ CheckPermissions (); StateChanged (u state); - NetworkManager's state changed. + +NetworkManager's state changed. u state: - (NMState) The new state of NetworkManager. + +(NMState) The new state of NetworkManager. + @@ -570,12 +680,15 @@ StateChanged (u state); DeviceAdded (o device_path); - A device was added to the system + +A device was added to the system o device_path: - The object path of the newly added device. + +The object path of the newly added device. + @@ -585,12 +698,15 @@ DeviceAdded (o device_path); DeviceRemoved (o device_path); - A device was removed from the system, and is no longer available. + +A device was removed from the system, and is no longer available. o device_path: - The object path of the device that was just removed. + +The object path of the device that was just removed. + @@ -603,9 +719,10 @@ DeviceRemoved (o device_path); Devices readable ao - The list of realized network devices. Realized devices are those which - have backing resources (eg from the kernel or a management daemon like - ModemManager, teamd, etc). + +The list of realized network devices. Realized devices are those which +have backing resources (eg from the kernel or a management daemon like +ModemManager, teamd, etc). @@ -614,9 +731,10 @@ Devices readable ao AllDevices readable ao - The list of both realized and un-realized network devices. Un-realized - devices are software devices which do not yet have backing resources, but - for which backing resources can be created if the device is activated. + +The list of both realized and un-realized network devices. Un-realized +devices are software devices which do not yet have backing resources, but +for which backing resources can be created if the device is activated. @@ -625,7 +743,8 @@ AllDevices readable ao Checkpoints readable ao - The list of active checkpoints. + +The list of active checkpoints. @@ -634,8 +753,9 @@ Checkpoints readable ao NetworkingEnabled readable b - Indicates if overall networking is currently enabled or not. See the - Enable() method. + +Indicates if overall networking is currently enabled or not. See the +Enable() method. @@ -644,7 +764,8 @@ NetworkingEnabled readable b WirelessEnabled readwrite b - Indicates if wireless is currently enabled or not. + +Indicates if wireless is currently enabled or not. @@ -653,8 +774,9 @@ WirelessEnabled readwrite b WirelessHardwareEnabled readable b - Indicates if the wireless hardware is currently enabled, i.e. the state of - the RF kill switch. + +Indicates if the wireless hardware is currently enabled, i.e. the state of +the RF kill switch. @@ -663,7 +785,8 @@ WirelessHardwareEnabled readable b WwanEnabled readwrite b - Indicates if mobile broadband devices are currently enabled or not. + +Indicates if mobile broadband devices are currently enabled or not. @@ -672,8 +795,9 @@ WwanEnabled readwrite b WwanHardwareEnabled readable b - Indicates if the mobile broadband hardware is currently enabled, i.e. the - state of the RF kill switch. + +Indicates if the mobile broadband hardware is currently enabled, i.e. the +state of the RF kill switch. @@ -682,8 +806,9 @@ WwanHardwareEnabled readable b WimaxEnabled readwrite b - DEPRECATED. Doesn't have any meaning and is around only for - compatibility reasons. + +DEPRECATED. Doesn't have any meaning and is around only for +compatibility reasons. @@ -692,8 +817,9 @@ WimaxEnabled readwrite b WimaxHardwareEnabled readable b - DEPRECATED. Doesn't have any meaning and is around only for - compatibility reasons. + +DEPRECATED. Doesn't have any meaning and is around only for +compatibility reasons. @@ -702,9 +828,10 @@ WimaxHardwareEnabled readable b RadioFlags readable u - Flags related to radio devices. See NMRadioFlags for the list of flags - supported. + +Flags related to radio devices. See NMRadioFlags for the list of flags +supported. Since 1.38 @@ -714,7 +841,8 @@ RadioFlags readable u ActiveConnections readable ao - List of active connection object paths. + +List of active connection object paths. @@ -723,11 +851,12 @@ ActiveConnections readable ao PrimaryConnection readable o - The object path of the "primary" active connection being used to access - the network. In particular, if there is no VPN active, or the VPN does not - have the default route, then this indicates the connection that has the - default route. If there is a VPN active with the default route, then this - indicates the connection that contains the route to the VPN endpoint. + +The object path of the "primary" active connection being used to access +the network. In particular, if there is no VPN active, or the VPN does not +have the default route, then this indicates the connection that has the +default route. If there is a VPN active with the default route, then this +indicates the connection that contains the route to the VPN endpoint. @@ -736,9 +865,10 @@ PrimaryConnection readable o PrimaryConnectionType readable s - The connection type of the "primary" active connection being used to - access the network. This is the same as the Type property on the object - indicated by PrimaryConnection. + +The connection type of the "primary" active connection being used to +access the network. This is the same as the Type property on the object +indicated by PrimaryConnection. @@ -747,9 +877,11 @@ PrimaryConnectionType readable s Metered readable u - Indicates whether the connectivity is metered. This is equivalent to the - metered property of the device associated with the primary connection. - Returns: NMMetered + +Indicates whether the connectivity is metered. This is equivalent to the +metered property of the device associated with the primary connection. + +Returns: NMMetered @@ -758,9 +890,10 @@ Metered readable u ActivatingConnection readable o - The object path of an active connection that is currently being activated - and which is expected to become the new PrimaryConnection when it finishes - activating. + +The object path of an active connection that is currently being activated +and which is expected to become the new PrimaryConnection when it finishes +activating. @@ -769,9 +902,10 @@ ActivatingConnection readable o Startup readable b - Indicates whether NM is still starting up; this becomes FALSE when NM has - finished attempting to activate every connection that it might be able to - activate at startup. + +Indicates whether NM is still starting up; this becomes FALSE when NM has +finished attempting to activate every connection that it might be able to +activate at startup. @@ -780,7 +914,8 @@ Startup readable b Version readable s - NetworkManager version. + +NetworkManager version. @@ -789,10 +924,11 @@ Version readable s Capabilities readable au - The current set of capabilities. See NMCapability for currently - defined capability numbers. The array is guaranteed to - be sorted in ascending order without duplicates. + +The current set of capabilities. See NMCapability for currently +defined capability numbers. The array is guaranteed to +be sorted in ascending order without duplicates. @@ -801,15 +937,19 @@ Capabilities readable au State readable u - The overall state of the NetworkManager daemon. - This takes state of all active connections and the connectivity state into account - to produce a single indicator of the network accessibility status. - The graphical shells may use this property to provide network connection status - indication and applications may use this to check if Internet connection is - accessible. Shell that is able to cope with captive portals should use the - "Connectivity" property to decide whether to present a captive portal authentication - dialog. - Returns: NMState + +The overall state of the NetworkManager daemon. + +This takes state of all active connections and the connectivity state into account +to produce a single indicator of the network accessibility status. + +The graphical shells may use this property to provide network connection status +indication and applications may use this to check if Internet connection is +accessible. Shell that is able to cope with captive portals should use the +"Connectivity" property to decide whether to present a captive portal authentication +dialog. + +Returns: NMState @@ -818,18 +958,22 @@ State readable u Connectivity readable u - The result of the last connectivity check. The connectivity check is triggered - automatically when a default connection becomes available, periodically and by - calling a CheckConnectivity() method. - This property is in general useful for the graphical shell to determine whether - the Internet access is being hijacked by an authentication gateway (a "captive - portal"). In such case it would typically present a web browser window to give - the user a chance to authenticate and call CheckConnectivity() when the user - submits a form or dismisses the window. - To determine the whether the user is able to access the Internet without dealing - with captive portals (e.g. to provide a network connection indicator or disable - controls that require Internet access), the "State" property is more suitable. - Returns: NMConnectivityState + +The result of the last connectivity check. The connectivity check is triggered +automatically when a default connection becomes available, periodically and by +calling a CheckConnectivity() method. + +This property is in general useful for the graphical shell to determine whether +the Internet access is being hijacked by an authentication gateway (a "captive +portal"). In such case it would typically present a web browser window to give +the user a chance to authenticate and call CheckConnectivity() when the user +submits a form or dismisses the window. + +To determine the whether the user is able to access the Internet without dealing +with captive portals (e.g. to provide a network connection indicator or disable +controls that require Internet access), the "State" property is more suitable. + +Returns: NMConnectivityState @@ -838,12 +982,14 @@ Connectivity readable u ConnectivityCheckAvailable readable b - Indicates whether connectivity checking service has been - configured. This may return true even if the service is not - currently enabled. - This is primarily intended for use in a privacy control panel, - as a way to determine whether to show an option to - enable/disable the feature. + +Indicates whether connectivity checking service has been +configured. This may return true even if the service is not +currently enabled. + +This is primarily intended for use in a privacy control panel, +as a way to determine whether to show an option to +enable/disable the feature. @@ -852,9 +998,10 @@ ConnectivityCheckAvailable readable b ConnectivityCheckEnabled readwrite b - Indicates whether connectivity checking is enabled. This - property can also be written to disable connectivity - checking (as a privacy control panel might want to do). + +Indicates whether connectivity checking is enabled. This +property can also be written to disable connectivity +checking (as a privacy control panel might want to do). @@ -863,7 +1010,8 @@ ConnectivityCheckEnabled readwrite b ConnectivityCheckUri readable s - The URI that NetworkManager will hit to check if there is internet connectivity. + +The URI that NetworkManager will hit to check if there is internet connectivity. @@ -872,14 +1020,15 @@ ConnectivityCheckUri readable s GlobalDnsConfiguration readwrite a{sv} - Dictionary of global DNS settings where the key is one of "searches", - "options" and "domains". The values for the "searches" and "options" keys - are string arrays describing the list of search domains and resolver - options, respectively. The value of the "domains" key is a second-level - dictionary, where each key is a domain name, and each key's value is a - third-level dictionary with the keys "servers" and "options". "servers" is - a string array of DNS servers, "options" is a string array of - domain-specific options. + +Dictionary of global DNS settings where the key is one of "searches", +"options" and "domains". The values for the "searches" and "options" keys +are string arrays describing the list of search domains and resolver +options, respectively. The value of the "domains" key is a second-level +dictionary, where each key is a domain name, and each key's value is a +third-level dictionary with the keys "servers" and "options". "servers" is +a string array of DNS servers, "options" is a string array of +domain-specific options. diff --git a/docs/api/html/NetworkManager-dispatcher.html b/docs/api/html/NetworkManager-dispatcher.html index 07397a71..d9a80e2f 100644 --- a/docs/api/html/NetworkManager-dispatcher.html +++ b/docs/api/html/NetworkManager-dispatcher.html @@ -8,7 +8,7 @@ - + @@ -325,6 +325,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/NetworkManager-wait-online.service.html b/docs/api/html/NetworkManager-wait-online.service.html index 2e252200..3f6d63d1 100644 --- a/docs/api/html/NetworkManager-wait-online.service.html +++ b/docs/api/html/NetworkManager-wait-online.service.html @@ -8,7 +8,7 @@ - + @@ -145,6 +145,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/NetworkManager.conf.html b/docs/api/html/NetworkManager.conf.html index 1a3152ee..15dfe367 100644 --- a/docs/api/html/NetworkManager.conf.html +++ b/docs/api/html/NetworkManager.conf.html @@ -8,7 +8,7 @@ - + @@ -1841,6 +1841,6 @@ interface-name:vboxnet*,except:interface-name:vboxnet2
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/NetworkManager.html b/docs/api/html/NetworkManager.html index 5119eacf..91e7e085 100644 --- a/docs/api/html/NetworkManager.html +++ b/docs/api/html/NetworkManager.html @@ -8,7 +8,7 @@ - + @@ -339,6 +339,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/ch01.html b/docs/api/html/ch01.html index 9863c8bd..e4cd603e 100644 --- a/docs/api/html/ch01.html +++ b/docs/api/html/ch01.html @@ -8,7 +8,7 @@ - + @@ -182,6 +182,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/dbus-secret-agent.html b/docs/api/html/dbus-secret-agent.html index 77edc023..b66890fd 100644 --- a/docs/api/html/dbus-secret-agent.html +++ b/docs/api/html/dbus-secret-agent.html @@ -8,7 +8,7 @@ - + @@ -27,6 +27,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/dbus-types.html b/docs/api/html/dbus-types.html index cfdccb55..b5eb97fd 100644 --- a/docs/api/html/dbus-types.html +++ b/docs/api/html/dbus-types.html @@ -8,7 +8,7 @@ - + @@ -27,6 +27,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/dbus-vpn-plugin.html b/docs/api/html/dbus-vpn-plugin.html index da728ca0..bb39e395 100644 --- a/docs/api/html/dbus-vpn-plugin.html +++ b/docs/api/html/dbus-vpn-plugin.html @@ -8,7 +8,7 @@ - + @@ -27,6 +27,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/dbus-vpn-types.html b/docs/api/html/dbus-vpn-types.html index a6c5d516..bb2edb32 100644 --- a/docs/api/html/dbus-vpn-types.html +++ b/docs/api/html/dbus-vpn-types.html @@ -8,7 +8,7 @@ - + @@ -27,6 +27,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.AccessPoint.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.AccessPoint.html index 99dcc77b..31349078 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.AccessPoint.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.AccessPoint.html @@ -8,7 +8,7 @@ - + @@ -49,7 +49,10 @@

Description

-

+

+

+

+

Property Details

@@ -58,9 +61,11 @@ 
 Flags  readable   u
-

Flags describing the capabilities of the access point. +

+Flags describing the capabilities of the access point.

-

Returns: NM80211ApFlags +

+Returns: NM80211ApFlags

@@ -69,10 +74,12 @@ Flags readable u 
 WpaFlags  readable   u
-

Flags describing the access point's capabilities according to WPA (Wifi - Protected Access). +

+Flags describing the access point's capabilities according to WPA (Wifi +Protected Access).

-

Returns: NM80211ApSecurityFlags +

+Returns: NM80211ApSecurityFlags

@@ -81,10 +88,12 @@ WpaFlags readable u 
 RsnFlags  readable   u
-

Flags describing the access point's capabilities according to the RSN - (Robust Secure Network) protocol. +

+Flags describing the access point's capabilities according to the RSN +(Robust Secure Network) protocol.

-

Returns: NM80211ApSecurityFlags +

+Returns: NM80211ApSecurityFlags

@@ -93,7 +102,8 @@ RsnFlags readable u 
 Ssid  readable   ay
-

The Service Set Identifier identifying the access point. +

+The Service Set Identifier identifying the access point.

@@ -102,7 +112,8 @@ Ssid readable ay 
 Frequency  readable   u
-

The radio channel frequency in use by the access point, in MHz. +

+The radio channel frequency in use by the access point, in MHz.

@@ -111,7 +122,8 @@ Frequency readable u 
 HwAddress  readable   s
-

The hardware address (BSSID) of the access point. +

+The hardware address (BSSID) of the access point.

@@ -120,9 +132,11 @@ HwAddress readable s 
 Mode  readable   u
-

Describes the operating mode of the access point. +

+Describes the operating mode of the access point.

-

Returns: NM80211Mode +

+Returns: NM80211Mode

@@ -131,8 +145,9 @@ Mode readable u 
 MaxBitrate  readable   u
-

The maximum bitrate this access point is capable of, in kilobits/second - (Kb/s). +

+The maximum bitrate this access point is capable of, in kilobits/second +(Kb/s).

@@ -141,7 +156,8 @@ MaxBitrate readable u 
 Strength  readable   y
-

The current signal quality of the access point, in percent. +

+The current signal quality of the access point, in percent.

@@ -150,14 +166,15 @@ Strength readable y 
 LastSeen  readable   i
-

The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access - point was found in scan results. A value of -1 means the access point has - never been found in scan results. +

+The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access +point was found in scan results. A value of -1 means the access point has +never been found in scan results.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.AgentManager.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.AgentManager.html index 242f8f0b..f230e84f 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.AgentManager.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.AgentManager.html @@ -8,7 +8,7 @@ - + @@ -42,7 +42,10 @@

Description

-

+

+

+

+

Method Details

@@ -51,8 +54,9 @@ 
 Register (IN  s identifier);
-

Called by secret Agents to register their ability to provide and save - network secrets. +

+Called by secret Agents to register their ability to provide and save +network secrets.

@@ -61,7 +65,9 @@ Register (IN s identifier); - +

IN s identifier:

Identifies this agent; only one agent in each user session may use the same identifier. Identifier formatting follows the same rules as D-Bus bus names with the exception that the ':' character is not allowed. The valid set of characters is "[A-Z][a-z][0-9]_-." and the identifier is limited in length to 255 characters with a minimum of 3 characters. An example valid identifier is 'org.gnome.nm-applet' (without quotes).

+Identifies this agent; only one agent in each user session may use the same identifier. Identifier formatting follows the same rules as D-Bus bus names with the exception that the ':' character is not allowed. The valid set of characters is "[A-Z][a-z][0-9]_-." and the identifier is limited in length to 255 characters with a minimum of 3 characters. An example valid identifier is 'org.gnome.nm-applet' (without quotes). +
@@ -72,7 +78,8 @@ Register (IN s identifier); RegisterWithCapabilities (IN s identifier, IN u capabilities); -

Like Register() but indicates agent capabilities to NetworkManager. +

+Like Register() but indicates agent capabilities to NetworkManager.

@@ -82,11 +89,15 @@ RegisterWithCapabilities (IN s identifier, - + - +

IN s identifier:

See the Register() method's identifier argument.

+See the Register() method's identifier argument. +

IN u capabilities:

(NMSecretAgentCapabilities) Indicates various agent capabilities to NetworkManager.

+(NMSecretAgentCapabilities) Indicates various agent capabilities to NetworkManager. +
@@ -97,14 +108,15 @@ RegisterWithCapabilities (IN s identifier, 
 Unregister ();
-

Called by secret Agents to notify NetworkManager that they will no longer - handle requests for network secrets. Agents are automatically unregistered - when they disconnect from D-Bus. +

+Called by secret Agents to notify NetworkManager that they will no longer +handle requests for network secrets. Agents are automatically unregistered +when they disconnect from D-Bus.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Checkpoint.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Checkpoint.html index 4247998b..729e0741 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Checkpoint.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Checkpoint.html @@ -8,7 +8,7 @@ - + @@ -42,7 +42,8 @@

Description

-

A snapshot of NetworkManager state for a given device list +

+A snapshot of NetworkManager state for a given device list

@@ -52,8 +53,9 @@ 
 Devices  readable   ao
-

Array of object paths for devices which are part of this - checkpoint. +

+Array of object paths for devices which are part of this +checkpoint.

@@ -62,7 +64,8 @@ Devices readable ao 
 Created  readable   x
-

The timestamp (in CLOCK_BOOTTIME milliseconds) of checkpoint creation. +

+The timestamp (in CLOCK_BOOTTIME milliseconds) of checkpoint creation.

@@ -71,12 +74,13 @@ Created readable x 
 RollbackTimeout  readable   u
-

Timeout in seconds for automatic rollback, or zero. +

+Timeout in seconds for automatic rollback, or zero.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html index b3526674..f6e96ea6 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html @@ -8,7 +8,7 @@ - + @@ -63,20 +63,21 @@

Description

-

Objects that implement the Connection.Active interface represent an - attempt to connect to a network using the details provided by a Connection - object. The Connection.Active object tracks the life-cycle of the - connection attempt and if successful indicates whether the connected - network is the "default" or preferred network for access. NetworkManager - has the concept of connections, which can be thought of as settings, a - profile or a configuration that can be applied on a networking device. - Such settings-connections are exposed as D-Bus object and the - active-connection expresses this relationship between device and - settings-connection. At any time a settings-connection can only be - activated on one device and vice versa. However, during activation and - deactivation multiple active-connections can reference the same device or - settings-connection as they are waiting to be activated or to be - deactivated. +

+Objects that implement the Connection.Active interface represent an +attempt to connect to a network using the details provided by a Connection +object. The Connection.Active object tracks the life-cycle of the +connection attempt and if successful indicates whether the connected +network is the "default" or preferred network for access. NetworkManager +has the concept of connections, which can be thought of as settings, a +profile or a configuration that can be applied on a networking device. +Such settings-connections are exposed as D-Bus object and the +active-connection expresses this relationship between device and +settings-connection. At any time a settings-connection can only be +activated on one device and vice versa. However, during activation and +deactivation multiple active-connections can reference the same device or +settings-connection as they are waiting to be activated or to be +deactivated.

@@ -87,7 +88,8 @@ StateChanged (u state, u reason); -

Emitted when the state of the active connection has changed. +

+Emitted when the state of the active connection has changed.

@@ -97,11 +99,15 @@ StateChanged (u state, - + - +

u state:

(NMActiveConnectionState) The new state of the active connection.

+(NMActiveConnectionState) The new state of the active connection. +

u reason:

(NMActiveConnectionStateReason) Reason code describing the change to the new state.

+(NMActiveConnectionStateReason) Reason code describing the change to the new state. +
@@ -115,7 +121,8 @@ StateChanged (u state, 
 Connection  readable   o
-

The path of the connection. +

+The path of the connection.

@@ -124,9 +131,10 @@ Connection readable o 
 SpecificObject  readable   o
-

A specific object associated with the active connection. This property - reflects the specific object used during connection activation, and will - not change over the lifetime of the ActiveConnection once set. +

+A specific object associated with the active connection. This property +reflects the specific object used during connection activation, and will +not change over the lifetime of the ActiveConnection once set.

@@ -135,8 +143,9 @@ SpecificObject readable o 
 Id  readable   s
-

The ID of the connection, provided as a convenience so that clients do not - have to retrieve all connection details. +

+The ID of the connection, provided as a convenience so that clients do not +have to retrieve all connection details.

@@ -145,8 +154,9 @@ Id readable s 
 Uuid  readable   s
-

The UUID of the connection, provided as a convenience so that clients do - not have to retrieve all connection details. +

+The UUID of the connection, provided as a convenience so that clients do +not have to retrieve all connection details.

@@ -155,8 +165,9 @@ Uuid readable s 
 Type  readable   s
-

The type of the connection, provided as a convenience so that clients do - not have to retrieve all connection details. +

+The type of the connection, provided as a convenience so that clients do +not have to retrieve all connection details.

@@ -165,8 +176,9 @@ Type readable s 
 Devices  readable   ao
-

Array of object paths representing devices which are part of this active - connection. +

+Array of object paths representing devices which are part of this active +connection.

@@ -175,9 +187,11 @@ Devices readable ao 
 State  readable   u
-

The state of this active connection. +

+The state of this active connection.

-

Returns: NMActiveConnectionState +

+Returns: NMActiveConnectionState

@@ -186,9 +200,11 @@ State readable u 
 StateFlags  readable   u
-

The state flags of this active connection. +

+The state flags of this active connection.

-

Returns: NMActivationStateFlags +

+Returns: NMActivationStateFlags

@@ -197,8 +213,9 @@ StateFlags readable u 
 Default  readable   b
-

Whether this active connection is the default IPv4 connection, i.e. - whether it currently owns the default IPv4 route. +

+Whether this active connection is the default IPv4 connection, i.e. +whether it currently owns the default IPv4 route.

@@ -207,9 +224,10 @@ Default readable b 
 Ip4Config  readable   o
-

Object path of the Ip4Config object describing the configuration of the - connection. Only valid when the connection is in the - NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. +

+Object path of the Ip4Config object describing the configuration of the +connection. Only valid when the connection is in the +NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.

@@ -218,9 +236,10 @@ Ip4Config readable o 
 Dhcp4Config  readable   o
-

Object path of the Dhcp4Config object describing the DHCP options returned - by the DHCP server (assuming the connection used DHCP). Only valid when - the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. +

+Object path of the Dhcp4Config object describing the DHCP options returned +by the DHCP server (assuming the connection used DHCP). Only valid when +the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.

@@ -229,8 +248,9 @@ Dhcp4Config readable o 
 Default6  readable   b
-

Whether this active connection is the default IPv6 connection, i.e. - whether it currently owns the default IPv6 route. +

+Whether this active connection is the default IPv6 connection, i.e. +whether it currently owns the default IPv6 route.

@@ -239,9 +259,10 @@ Default6 readable b 
 Ip6Config  readable   o
-

Object path of the Ip6Config object describing the configuration of the - connection. Only valid when the connection is in the - NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. +

+Object path of the Ip6Config object describing the configuration of the +connection. Only valid when the connection is in the +NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.

@@ -250,9 +271,10 @@ Ip6Config readable o 
 Dhcp6Config  readable   o
-

Object path of the Dhcp6Config object describing the DHCP options returned - by the DHCP server (assuming the connection used DHCP). Only valid when - the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. +

+Object path of the Dhcp6Config object describing the DHCP options returned +by the DHCP server (assuming the connection used DHCP). Only valid when +the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.

@@ -261,7 +283,8 @@ Dhcp6Config readable o 
 Vpn  readable   b
-

Whether this active connection is also a VPN connection. +

+Whether this active connection is also a VPN connection.

@@ -270,12 +293,13 @@ Vpn readable b 
 Master  readable   o
-

The path to the master device if the connection is a slave. +

+The path to the master device if the connection is a slave.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP4Config.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP4Config.html index 7563d0ea..142d2fcc 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP4Config.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP4Config.html @@ -8,7 +8,7 @@ - + @@ -40,7 +40,8 @@

Description

-

Options and configuration returned by the IPv4 DHCP server. +

+Options and configuration returned by the IPv4 DHCP server.

@@ -50,12 +51,13 @@ 
 Options  readable   a{sv}
-

Configuration options returned by a DHCP server, if any. +

+Configuration options returned by a DHCP server, if any.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP6Config.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP6Config.html index 4dbe3ffa..2038be09 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP6Config.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP6Config.html @@ -8,7 +8,7 @@ - + @@ -40,7 +40,8 @@

Description

-

Options and configuration returned by the IPv6 DHCP server. +

+Options and configuration returned by the IPv6 DHCP server.

@@ -50,12 +51,13 @@ 
 Options  readable   a{sv}
-

Configuration options returned by a DHCP server, if any. +

+Configuration options returned by a DHCP server, if any.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Adsl.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Adsl.html index 7a0fe15a..305f3e76 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Adsl.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Adsl.html @@ -8,7 +8,7 @@ - + @@ -40,7 +40,10 @@

Description

-

+

+

+

+

Property Details

@@ -49,15 +52,17 @@ 
 Carrier  readable   b
-

Indicates whether the physical carrier is found. +

+Indicates whether the physical carrier is found.

-

DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" - property on the "org.freedesktop.NetworkManager.Device" interface. +

+DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" +property on the "org.freedesktop.NetworkManager.Device" interface.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bluetooth.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bluetooth.html index 3c577596..af50c253 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bluetooth.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bluetooth.html @@ -8,7 +8,7 @@ - + @@ -42,7 +42,10 @@

Description

-

+

+

+

+

Property Details

@@ -51,9 +54,11 @@ 
 HwAddress  readable   s
-

Bluetooth hardware address of the device. +

+Bluetooth hardware address of the device.

-

DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +

+DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.

@@ -62,7 +67,8 @@ HwAddress readable s 
 Name  readable   s
-

Bluetooth name of the device. +

+Bluetooth name of the device.

@@ -71,14 +77,16 @@ Name readable s 
 BtCapabilities  readable   u
-

Bluetooth capabilities of the device (either DUN or NAP). +

+Bluetooth capabilities of the device (either DUN or NAP).

-

Returns: NMBluetoothCapabilities +

+Returns: NMBluetoothCapabilities

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bond.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bond.html index d17fb6a8..c66f8f9b 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bond.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bond.html @@ -8,7 +8,7 @@ - + @@ -42,7 +42,10 @@

Description

-

+

+

+

+

Property Details

@@ -51,9 +54,10 @@ 
 HwAddress  readable   s
-

Hardware address of the device. +

+Hardware address of the device. n - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.

@@ -62,11 +66,13 @@ n 
 Carrier  readable   b
-

Indicates whether the physical carrier is found (e.g. whether a cable is - plugged in or not). +

+Indicates whether the physical carrier is found (e.g. whether a cable is +plugged in or not).

-

DEPRECATED: check for the "lower-up" flag in the "InterfaceFlags" - property on the "org.freedesktop.NetworkManager.Device" interface. +

+DEPRECATED: check for the "lower-up" flag in the "InterfaceFlags" +property on the "org.freedesktop.NetworkManager.Device" interface.

@@ -75,14 +81,15 @@ Carrier readable b 
 Slaves  readable   ao
-

DEPRECATED. Use the "Ports" property in - "org.freedesktop.NetworkManager.Device" instead which exists since - version NetworkManager 1.34.0. +

+DEPRECATED. Use the "Ports" property in +"org.freedesktop.NetworkManager.Device" instead which exists since +version NetworkManager 1.34.0.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bridge.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bridge.html index df4eebb4..050a8d2d 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bridge.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bridge.html @@ -8,7 +8,7 @@ - + @@ -42,7 +42,10 @@

Description

-

+

+

+

+

Property Details

@@ -51,9 +54,10 @@ 
 HwAddress  readable   s
-

Hardware address of the device. +

+Hardware address of the device. n - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.

@@ -62,11 +66,13 @@ n 
 Carrier  readable   b
-

Indicates whether the physical carrier is found (e.g. whether a cable is - plugged in or not). +

+Indicates whether the physical carrier is found (e.g. whether a cable is +plugged in or not).

-

DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" - property on the "org.freedesktop.NetworkManager.Device" interface. +

+DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" +property on the "org.freedesktop.NetworkManager.Device" interface.

@@ -75,14 +81,15 @@ Carrier readable b 
 Slaves  readable   ao
-

DEPRECATED. Use the "Ports" property in - "org.freedesktop.NetworkManager.Device" instead which exists since - version NetworkManager 1.34.0. +

+DEPRECATED. Use the "Ports" property in +"org.freedesktop.NetworkManager.Device" instead which exists since +version NetworkManager 1.34.0.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Dummy.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Dummy.html index 48682cff..bfa69828 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Dummy.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Dummy.html @@ -8,7 +8,7 @@ - + @@ -40,7 +40,10 @@

Description

-

+

+

+

+

Property Details

@@ -49,14 +52,15 @@ 
 HwAddress  readable   s
-

Hardware address of the device. +

+Hardware address of the device. n - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Generic.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Generic.html index 094abcd2..654fc147 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Generic.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Generic.html @@ -8,7 +8,7 @@ - + @@ -41,7 +41,10 @@

Description

-

+

+

+

+

Property Details

@@ -50,9 +53,10 @@ 
 HwAddress  readable   s
-

Hardware address of the device. +

+Hardware address of the device. n - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.

@@ -61,12 +65,13 @@ n 
 TypeDescription  readable   s
-

A (non-localized) description of the interface type, if known. +

+A (non-localized) description of the interface type, if known.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.IPTunnel.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.IPTunnel.html index 45860f06..cdf6a946 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.IPTunnel.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.IPTunnel.html @@ -8,7 +8,7 @@ - + @@ -51,7 +51,10 @@

Description

-

+

+

+

+

Property Details

@@ -60,7 +63,8 @@ 
 Mode  readable   u
-

The tunneling mode. +

+The tunneling mode.

@@ -69,7 +73,8 @@ Mode readable u 
 Parent  readable   o
-

The object path of the parent device. +

+The object path of the parent device.

@@ -78,7 +83,8 @@ Parent readable o 
 Local  readable   s
-

The local endpoint of the tunnel. +

+The local endpoint of the tunnel.

@@ -87,7 +93,8 @@ Local readable s 
 Remote  readable   s
-

The remote endpoint of the tunnel. +

+The remote endpoint of the tunnel.

@@ -96,8 +103,9 @@ Remote readable s 
 Ttl  readable   y
-

The TTL assigned to tunneled packets. 0 is a special value meaning that - packets inherit the TTL value +

+The TTL assigned to tunneled packets. 0 is a special value meaning that +packets inherit the TTL value

@@ -106,8 +114,9 @@ Ttl readable y 
 Tos  readable   y
-

The type of service (IPv4) or traffic class (IPv6) assigned to tunneled - packets. +

+The type of service (IPv4) or traffic class (IPv6) assigned to tunneled +packets.

@@ -116,7 +125,8 @@ Tos readable y 
 PathMtuDiscovery  readable   b
-

Whether path MTU discovery is enabled on this tunnel. +

+Whether path MTU discovery is enabled on this tunnel.

@@ -125,7 +135,8 @@ PathMtuDiscovery readable b 
 InputKey  readable   s
-

The key used for incoming packets. +

+The key used for incoming packets.

@@ -134,7 +145,8 @@ InputKey readable s 
 OutputKey  readable   s
-

The key used for outgoing packets. +

+The key used for outgoing packets.

@@ -143,8 +155,9 @@ OutputKey readable s 
 EncapsulationLimit  readable   y
-

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.

@@ -153,8 +166,9 @@ EncapsulationLimit readable y 
 FlowLabel  readable   u
-

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.

@@ -163,12 +177,13 @@ FlowLabel readable u 
 Flags  readable   u
-

Tunnel flags. +

+Tunnel flags.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Infiniband.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Infiniband.html index d9ce23e3..c706d1ff 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Infiniband.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Infiniband.html @@ -8,7 +8,7 @@ - + @@ -41,7 +41,10 @@

Description

-

+

+

+

+

Property Details

@@ -50,9 +53,10 @@ 
 HwAddress  readable   s
-

Hardware address of the device. +

+Hardware address of the device. n - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.

@@ -61,16 +65,18 @@ n 
 Carrier  readable   b
-

Indicates whether the physical carrier is found (e.g. whether a cable is - plugged in or not). +

+Indicates whether the physical carrier is found (e.g. whether a cable is +plugged in or not).

-

DEPRECATED: check for the "lower-up" flag in the "InterfaceFlags" - property on the "org.freedesktop.NetworkManager.Device" interface. +

+DEPRECATED: check for the "lower-up" flag in the "InterfaceFlags" +property on the "org.freedesktop.NetworkManager.Device" interface.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Lowpan.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Lowpan.html index f8e9c123..8d85d33a 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Lowpan.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Lowpan.html @@ -8,7 +8,7 @@ - + @@ -41,7 +41,10 @@

Description

-

+

+

+

+

Property Details

@@ -50,9 +53,11 @@ 
 HwAddress  readable   s
-

The active hardware address of the device. +

+The active hardware address of the device.

-

DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +

+DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.

@@ -61,12 +66,13 @@ HwAddress readable s 
 Parent  readable   o
-

The object path of the parent device. +

+The object path of the parent device.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macsec.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macsec.html index 1ea34f2c..795aee21 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macsec.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macsec.html @@ -8,7 +8,7 @@ - + @@ -52,7 +52,10 @@

Description

-

+

+

+

+

Property Details

@@ -61,7 +64,8 @@ 
 Parent  readable   o
-

The object path of the parent device. +

+The object path of the parent device.

@@ -70,7 +74,8 @@ Parent readable o 
 Sci  readable   t
-

The Secure Channel Identifier in use. +

+The Secure Channel Identifier in use.

@@ -79,7 +84,8 @@ Sci readable t 
 IcvLength  readable   y
-

The length of ICV (Integrity Check Value). +

+The length of ICV (Integrity Check Value).

@@ -88,8 +94,9 @@ IcvLength readable y 
 CipherSuite  readable   t
-

The set of cryptographic algorithms in use - (e.g. 0x0080020001000001 for GCM-AES-128). +

+The set of cryptographic algorithms in use +(e.g. 0x0080020001000001 for GCM-AES-128).

@@ -98,7 +105,8 @@ CipherSuite readable t 
 Window  readable   u
-

The size of the replay window. +

+The size of the replay window.

@@ -107,8 +115,9 @@ Window readable u 
 EncodingSa  readable   y
-

The value of the Association Number (0..3) for the Security - Association in use. +

+The value of the Association Number (0..3) for the Security +Association in use.

@@ -117,8 +126,9 @@ EncodingSa readable y 
 Validation  readable   s
-

The validation mode for incoming packets (strict, check, - disabled). +

+The validation mode for incoming packets (strict, check, +disabled).

@@ -127,7 +137,8 @@ Validation readable s 
 Encrypt  readable   b
-

Whether encryption of transmitted frames is enabled. +

+Whether encryption of transmitted frames is enabled.

@@ -136,7 +147,8 @@ Encrypt readable b 
 Protect  readable   b
-

Whether protection of transmitted frames is enabled. +

+Whether protection of transmitted frames is enabled.

@@ -145,8 +157,9 @@ Protect readable b 
 IncludeSci  readable   b
-

Whether the SCI is always included in SecTAG for transmitted - frames. +

+Whether the SCI is always included in SecTAG for transmitted +frames.

@@ -155,8 +168,9 @@ IncludeSci readable b 
 Es  readable   b
-

Whether the ES (End station) bit is enabled in SecTAG for - transmitted frames. +

+Whether the ES (End station) bit is enabled in SecTAG for +transmitted frames.

@@ -165,8 +179,9 @@ Es readable b 
 Scb  readable   b
-

Whether the SCB (Single Copy Broadcast) bit is enabled in - SecTAG for transmitted frames. +

+Whether the SCB (Single Copy Broadcast) bit is enabled in +SecTAG for transmitted frames.

@@ -175,12 +190,13 @@ Scb readable b 
 ReplayProtect  readable   b
-

Whether replay protection is enabled. +

+Whether replay protection is enabled.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macvlan.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macvlan.html index 3b6ab272..fcbb003c 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macvlan.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macvlan.html @@ -8,7 +8,7 @@ - + @@ -43,7 +43,10 @@

Description

-

+

+

+

+

Property Details

@@ -52,7 +55,8 @@ 
 Parent  readable   o
-

The object path of the parent device. +

+The object path of the parent device.

@@ -61,7 +65,8 @@ Parent readable o 
 Mode  readable   s
-

The macvlan mode, one of "private", "vepa", "bridge", or "passthru". +

+The macvlan mode, one of "private", "vepa", "bridge", or "passthru".

@@ -70,7 +75,8 @@ Mode readable s 
 NoPromisc  readable   b
-

Whether the device is blocked from going into promiscuous mode. +

+Whether the device is blocked from going into promiscuous mode.

@@ -79,12 +85,13 @@ NoPromisc readable b 
 Tap  readable   b
-

Whether the device is a macvtap. +

+Whether the device is a macvtap.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Modem.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Modem.html index 815f00ea..4b6cc204 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Modem.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Modem.html @@ -8,7 +8,7 @@ - + @@ -44,7 +44,10 @@

Description

-

+

+

+

+

Property Details

@@ -53,12 +56,14 @@ 
 ModemCapabilities  readable   u
-

The generic family of access technologies the modem supports. Not all - capabilities are available at the same time however; some modems require a - firmware reload or other reinitialization to switch between eg CDMA/EVDO - and GSM/UMTS. +

+The generic family of access technologies the modem supports. Not all +capabilities are available at the same time however; some modems require a +firmware reload or other reinitialization to switch between eg CDMA/EVDO +and GSM/UMTS.

-

Returns: NMDeviceModemCapabilities +

+Returns: NMDeviceModemCapabilities

@@ -67,10 +72,12 @@ ModemCapabilities readable u 
 CurrentCapabilities  readable   u
-

The generic family of access technologies the modem currently supports - without a firmware reload or reinitialization. +

+The generic family of access technologies the modem currently supports +without a firmware reload or reinitialization.

-

Returns: NMDeviceModemCapabilities +

+Returns: NMDeviceModemCapabilities

@@ -79,9 +86,10 @@ CurrentCapabilities readable u 
 DeviceId  readable   s
-

An identifier used by the modem backend (ModemManager) that aims to - uniquely identify the a device. Can be used to match a connection to a - particular device. +

+An identifier used by the modem backend (ModemManager) that aims to +uniquely identify the a device. Can be used to match a connection to a +particular device.

Since 1.20

@@ -91,8 +99,9 @@ DeviceId readable s 
 OperatorCode  readable   s
-

The MCC and MNC (concatenated) of the network the modem is connected to. - Blank if disconnected or not a 3GPP modem. +

+The MCC and MNC (concatenated) of the network the modem is connected to. +Blank if disconnected or not a 3GPP modem.

Since 1.20

@@ -102,13 +111,14 @@ OperatorCode readable s 
 Apn  readable   s
-

The access point name the modem is connected to. Blank if disconnected. +

+The access point name the modem is connected to. Blank if disconnected.

Since 1.20

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OlpcMesh.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OlpcMesh.html index c60086c5..2f71abd8 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OlpcMesh.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OlpcMesh.html @@ -8,7 +8,7 @@ - + @@ -42,7 +42,10 @@

Description

-

+

+

+

+

Property Details

@@ -51,9 +54,11 @@ 
 HwAddress  readable   s
-

The hardware address of the device. +

+The hardware address of the device.

-

DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +

+DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.

@@ -62,7 +67,8 @@ HwAddress readable s 
 Companion  readable   o
-

The object path of the companion device. +

+The object path of the companion device.

@@ -71,12 +77,13 @@ Companion readable o 
 ActiveChannel  readable   u
-

The currently active channel. +

+The currently active channel.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsBridge.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsBridge.html index 10fc724c..46b3fbd4 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsBridge.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsBridge.html @@ -8,7 +8,7 @@ - + @@ -40,7 +40,10 @@

Description

-

+

+

+

+

Property Details

@@ -49,15 +52,16 @@ 
 Slaves  readable   ao
-

DEPRECATED. Use the "Ports" property in - "org.freedesktop.NetworkManager.Device" instead which exists since - version NetworkManager 1.34.0. +

+DEPRECATED. Use the "Ports" property in +"org.freedesktop.NetworkManager.Device" instead which exists since +version NetworkManager 1.34.0.

Since 1.14

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsInterface.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsInterface.html index ee00d7b2..ef46a103 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsInterface.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsInterface.html @@ -8,7 +8,7 @@ - + @@ -33,10 +33,13 @@

Description

-

+

+

+

+

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsPort.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsPort.html index 9d4ecb8e..08cf13ba 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsPort.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsPort.html @@ -8,7 +8,7 @@ - + @@ -40,7 +40,10 @@

Description

-

+

+

+

+

Property Details

@@ -49,15 +52,16 @@ 
 Slaves  readable   ao
-

DEPRECATED. Use the "Ports" property in - "org.freedesktop.NetworkManager.Device" instead which exists since - version NetworkManager 1.34.0. +

+DEPRECATED. Use the "Ports" property in +"org.freedesktop.NetworkManager.Device" instead which exists since +version NetworkManager 1.34.0.

Since 1.14

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Ppp.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Ppp.html index e1caa59f..ee50d1cc 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Ppp.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Ppp.html @@ -8,7 +8,7 @@ - + @@ -33,10 +33,13 @@

Description

-

+

+

+

+

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Statistics.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Statistics.html index fee2c027..14597116 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Statistics.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Statistics.html @@ -8,7 +8,7 @@ - + @@ -42,7 +42,10 @@

Description

-

+

+

+

+

Property Details

@@ -51,10 +54,11 @@ 
 RefreshRateMs  readwrite  u
-

Refresh rate of the rest of properties of this interface. The properties - are guaranteed to be refreshed each RefreshRateMs milliseconds in case - the underlying counter has changed too. - If zero, there is no guaranteed refresh rate of the properties. +

+Refresh rate of the rest of properties of this interface. The properties +are guaranteed to be refreshed each RefreshRateMs milliseconds in case +the underlying counter has changed too. +If zero, there is no guaranteed refresh rate of the properties.

@@ -63,7 +67,8 @@ RefreshRateMs readwrite u 
 TxBytes  readable   t
-

Number of transmitted bytes +

+Number of transmitted bytes

@@ -72,12 +77,13 @@ TxBytes readable t 
 RxBytes  readable   t
-

Number of received bytes +

+Number of received bytes

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Team.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Team.html index 19fe70de..5864fd40 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Team.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Team.html @@ -8,7 +8,7 @@ - + @@ -43,7 +43,10 @@

Description

-

+

+

+

+

Property Details

@@ -52,9 +55,10 @@ 
 HwAddress  readable   s
-

Hardware address of the device. +

+Hardware address of the device. n - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.

@@ -63,11 +67,13 @@ n 
 Carrier  readable   b
-

Indicates whether the physical carrier is found (e.g. whether a cable is - plugged in or not). +

+Indicates whether the physical carrier is found (e.g. whether a cable is +plugged in or not).

-

DEPRECATED: check for the "lower-up" flag in the "InterfaceFlags" - property on the "org.freedesktop.NetworkManager.Device" interface. +

+DEPRECATED: check for the "lower-up" flag in the "InterfaceFlags" +property on the "org.freedesktop.NetworkManager.Device" interface.

@@ -76,9 +82,10 @@ Carrier readable b 
 Slaves  readable   ao
-

DEPRECATED. Use the "Ports" property in - "org.freedesktop.NetworkManager.Device" instead which exists since - version NetworkManager 1.34.0. +

+DEPRECATED. Use the "Ports" property in +"org.freedesktop.NetworkManager.Device" instead which exists since +version NetworkManager 1.34.0.

@@ -87,12 +94,13 @@ Slaves readable ao 
 Config  readable   s
-

The JSON configuration currently applied on the device. +

+The JSON configuration currently applied on the device.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Tun.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Tun.html index 33ecfb60..8c05cf5c 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Tun.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Tun.html @@ -8,7 +8,7 @@ - + @@ -46,7 +46,10 @@

Description

-

+

+

+

+

Property Details

@@ -55,7 +58,8 @@ 
 Owner  readable   x
-

The uid of the tunnel owner, or -1 if it has no owner. +

+The uid of the tunnel owner, or -1 if it has no owner.

@@ -64,7 +68,8 @@ Owner readable x 
 Group  readable   x
-

The gid of the tunnel group, or -1 if it has no owner. +

+The gid of the tunnel group, or -1 if it has no owner.

@@ -73,7 +78,8 @@ Group readable x 
 Mode  readable   s
-

The tunnel mode, either "tun" or "tap". +

+The tunnel mode, either "tun" or "tap".

@@ -82,8 +88,9 @@ Mode readable s 
 NoPi  readable   b
-

The tunnel's "TUN_NO_PI" flag; true if no protocol info is prepended to - the tunnel packets. +

+The tunnel's "TUN_NO_PI" flag; true if no protocol info is prepended to +the tunnel packets.

@@ -92,8 +99,9 @@ NoPi readable b 
 VnetHdr  readable   b
-

The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets include a - virtio network header. +

+The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets include a +virtio network header.

@@ -102,8 +110,9 @@ VnetHdr readable b 
 MultiQueue  readable   b
-

The tunnel's "TUN_TAP_MQ" flag; true if callers can connect to the tap - device multiple times, for multiple send/receive queues. +

+The tunnel's "TUN_TAP_MQ" flag; true if callers can connect to the tap +device multiple times, for multiple send/receive queues.

@@ -112,14 +121,15 @@ MultiQueue readable b 
 HwAddress  readable   s
-

Hardware address of the device. +

+Hardware address of the device. n - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Veth.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Veth.html index a28112a1..46b788f2 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Veth.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Veth.html @@ -8,7 +8,7 @@ - + @@ -40,7 +40,10 @@

Description

-

+

+

+

+

Property Details

@@ -49,12 +52,13 @@ 
 Peer  readable   o
-

The object path of the device's peer. +

+The object path of the device's peer.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vlan.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vlan.html index fc86b6bf..a55b8250 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vlan.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vlan.html @@ -8,7 +8,7 @@ - + @@ -43,7 +43,10 @@

Description

-

+

+

+

+

Property Details

@@ -52,9 +55,10 @@ 
 HwAddress  readable   s
-

Hardware address of the device. +

+Hardware address of the device. n - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.

@@ -63,11 +67,13 @@ n 
 Carrier  readable   b
-

Indicates whether the physical carrier is found (e.g. whether a cable is - plugged in or not). +

+Indicates whether the physical carrier is found (e.g. whether a cable is +plugged in or not).

-

DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" - property on the "org.freedesktop.NetworkManager.Device" interface. +

+DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" +property on the "org.freedesktop.NetworkManager.Device" interface.

@@ -76,7 +82,8 @@ Carrier readable b 
 Parent  readable   o
-

Object path of the parent device of this VLAN device. +

+Object path of the parent device of this VLAN device.

@@ -85,12 +92,13 @@ Parent readable o 
 VlanId  readable   u
-

The VLAN ID of this VLAN interface. +

+The VLAN ID of this VLAN interface.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vrf.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vrf.html index 76467075..88e848a0 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vrf.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vrf.html @@ -8,7 +8,7 @@ - + @@ -40,7 +40,10 @@

Description

-

+

+

+

+

Property Details

@@ -49,12 +52,13 @@ 
 Table  readable   u
-

The routing table of the VRF. +

+The routing table of the VRF.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vxlan.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vxlan.html index 970228f2..9349aa4c 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vxlan.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vxlan.html @@ -8,7 +8,7 @@ - + @@ -56,7 +56,10 @@

Description

-

+

+

+

+

Property Details

@@ -65,8 +68,9 @@ 
 Parent  readable   o
-

The object path of the parent device (if the VXLAN is not purely internal - to this host). +

+The object path of the parent device (if the VXLAN is not purely internal +to this host).

@@ -75,9 +79,10 @@ Parent readable o 
 HwAddress  readable   s
-

Hardware address of the device. +

+Hardware address of the device. n - DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.

@@ -86,7 +91,8 @@ n 
 Id  readable   u
-

The VXLAN Network Identifier (VNI). +

+The VXLAN Network Identifier (VNI).

@@ -95,8 +101,9 @@ Id readable u 
 Group  readable   s
-

The IP (v4 or v6) multicast group used to communicate with other physical - hosts on this VXLAN. +

+The IP (v4 or v6) multicast group used to communicate with other physical +hosts on this VXLAN.

@@ -105,8 +112,9 @@ Group readable s 
 Local  readable   s
-

The local IPv4 or IPv6 address to use when sending VXLAN packets to other - physical hosts. +

+The local IPv4 or IPv6 address to use when sending VXLAN packets to other +physical hosts.

@@ -115,8 +123,9 @@ Local readable s 
 Tos  readable   y
-

The value to use in the IP ToS field for VXLAN packets sent to other - physical hosts. +

+The value to use in the IP ToS field for VXLAN packets sent to other +physical hosts.

@@ -125,8 +134,9 @@ Tos readable y 
 Ttl  readable   y
-

The value to use in the IP TTL field for VXLAN packets sent to other - physical hosts. +

+The value to use in the IP TTL field for VXLAN packets sent to other +physical hosts.

@@ -135,7 +145,8 @@ Ttl readable y 
 Learning  readable   b
-

True if the VXLAN dynamically learns remote IP addresses. +

+True if the VXLAN dynamically learns remote IP addresses.

@@ -144,7 +155,8 @@ Learning readable b 
 Ageing  readable   u
-

The interval in seconds at which the kernel purges stale cached addresses. +

+The interval in seconds at which the kernel purges stale cached addresses.

@@ -153,8 +165,9 @@ Ageing readable u 
 Limit  readable   u
-

The maximum number of entries that can be added to the VXLAN's forwarding - table. +

+The maximum number of entries that can be added to the VXLAN's forwarding +table.

@@ -163,7 +176,8 @@ Limit readable u 
 DstPort  readable   q
-

Destination port for outgoing VXLAN packets. +

+Destination port for outgoing VXLAN packets.

@@ -172,7 +186,8 @@ DstPort readable q 
 SrcPortMin  readable   q
-

The lowest source port number to use for outgoing VXLAN packets. +

+The lowest source port number to use for outgoing VXLAN packets.

@@ -181,7 +196,8 @@ SrcPortMin readable q 
 SrcPortMax  readable   q
-

The highest source port number to use for outgoing VXLAN packets. +

+The highest source port number to use for outgoing VXLAN packets.

@@ -190,7 +206,8 @@ SrcPortMax readable q 
 Proxy  readable   b
-

True if the VXLAN is implementing DOVE ARP proxying for remote clients. +

+True if the VXLAN is implementing DOVE ARP proxying for remote clients.

@@ -199,8 +216,9 @@ Proxy readable b 
 Rsc  readable   b
-

True if the VXLAN is implementing DOVE route short-circuiting of known - remote IP addresses. +

+True if the VXLAN is implementing DOVE route short-circuiting of known +remote IP addresses.

@@ -209,7 +227,8 @@ Rsc readable b 
 L2miss  readable   b
-

True if the VXLAN will emit netlink notifications of L2 switch misses. +

+True if the VXLAN will emit netlink notifications of L2 switch misses.

@@ -218,12 +237,13 @@ L2miss readable b 
 L3miss  readable   b
-

True if the VXLAN will emit netlink notifications of L3 switch misses. +

+True if the VXLAN will emit netlink notifications of L3 switch misses.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WifiP2P.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WifiP2P.html index 25f2d66a..2ef395cf 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WifiP2P.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WifiP2P.html @@ -8,7 +8,7 @@ - + @@ -56,7 +56,10 @@

Description

-

+

+

+

+

Since 1.16

@@ -66,11 +69,14 @@ 
 StartFind (IN  a{sv} options);
-

Start a find operation for Wi-Fi P2P peers. +

+Start a find operation for Wi-Fi P2P peers. +

+

+The options argument accepts the following keys:

-

The options argument accepts the following keys: +

-

@@ -93,7 +99,9 @@ StartFind (IN a{sv} options); - +

IN a{sv} options:

Options of find.

+Options of find. +

Since 1.16

@@ -104,7 +112,8 @@ StartFind (IN a{sv} options); 
 StopFind ();
-

Stop an ongoing find operation again. +

+Stop an ongoing find operation again.

Since 1.16

@@ -116,7 +125,8 @@ StopFind (); 
 PeerAdded (o peer);
-

Emitted when a new Wi-Fi P2P peer is found by the device. +

+Emitted when a new Wi-Fi P2P peer is found by the device.

@@ -125,7 +135,9 @@ PeerAdded (o peer); - +

o peer:

The object path of the newly found access point.

+The object path of the newly found access point. +

Since 1.16

@@ -136,7 +148,8 @@ PeerAdded (o peer); 
 PeerRemoved (o peer);
-

Emitted when a Wi-Fi P2P peer disappears from view of the device. +

+Emitted when a Wi-Fi P2P peer disappears from view of the device.

@@ -145,7 +158,9 @@ PeerRemoved (o peer); - +

o peer:

The object path of the Wi-Fi P2P peer that has disappeared.

+The object path of the Wi-Fi P2P peer that has disappeared. +

Since 1.16

@@ -158,9 +173,11 @@ PeerRemoved (o peer); 
 HwAddress  readable   s
-

The active hardware address of the device. +

+The active hardware address of the device.

-

DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +

+DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.

Since 1.16

@@ -170,13 +187,14 @@ HwAddress readable s 
 Peers  readable   ao
-

List of object paths of peers visible to this Wi-Fi P2P device. +

+List of object paths of peers visible to this Wi-Fi P2P device.

Since 1.16

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WireGuard.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WireGuard.html index 6e56e2af..60ad16dc 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WireGuard.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WireGuard.html @@ -8,7 +8,7 @@ - + @@ -42,7 +42,10 @@

Description

-

+

+

+

+

Property Details

@@ -51,7 +54,8 @@ 
 PublicKey  readable   ay
-

32-byte public WireGuard key. +

+32-byte public WireGuard key.

@@ -60,7 +64,8 @@ PublicKey readable ay 
 ListenPort  readable   q
-

Local UDP listening port. +

+Local UDP listening port.

@@ -69,13 +74,14 @@ ListenPort readable q 
 FwMark  readable   u
-

Optional 32-bit mark used to set routing policy for outgoing encrypted packets. - See: ip-rule(8) +

+Optional 32-bit mark used to set routing policy for outgoing encrypted packets. +See: ip-rule(8)

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wired.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wired.html index 9a4cf88d..e62fe697 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wired.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wired.html @@ -8,7 +8,7 @@ - + @@ -44,7 +44,10 @@

Description

-

+

+

+

+

Property Details

@@ -53,9 +56,11 @@ 
 HwAddress  readable   s
-

Active hardware address of the device. +

+Active hardware address of the device.

-

DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +

+DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.

@@ -64,7 +69,8 @@ HwAddress readable s 
 PermHwAddress  readable   s
-

Permanent hardware address of the device. +

+Permanent hardware address of the device.

@@ -73,7 +79,8 @@ PermHwAddress readable s 
 Speed  readable   u
-

Design speed of the device, in megabits/second (Mb/s). +

+Design speed of the device, in megabits/second (Mb/s).

@@ -82,7 +89,8 @@ Speed readable u 
 S390Subchannels  readable   as
-

Array of S/390 subchannels for S/390 or z/Architecture devices. +

+Array of S/390 subchannels for S/390 or z/Architecture devices.

@@ -91,16 +99,18 @@ S390Subchannels readable as 
 Carrier  readable   b
-

Indicates whether the physical carrier is found (e.g. whether a cable is - plugged in or not). +

+Indicates whether the physical carrier is found (e.g. whether a cable is +plugged in or not).

-

DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" - property on the "org.freedesktop.NetworkManager.Device" interface. +

+DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" +property on the "org.freedesktop.NetworkManager.Device" interface.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wireless.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wireless.html index 7c6ab847..39d0305d 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wireless.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wireless.html @@ -8,7 +8,7 @@ - + @@ -63,7 +63,10 @@

Description

-

+

+

+

+

Method Details

@@ -72,10 +75,11 @@ 
 GetAccessPoints (OUT ao access_points);
-

DEPRECATED. Get the list of access points visible to this device. Note - that this list does not include access points which hide their SSID. To - retrieve a list of all access points (including hidden ones) use the - GetAllAccessPoints() method. +

+DEPRECATED. Get the list of access points visible to this device. Note +that this list does not include access points which hide their SSID. To +retrieve a list of all access points (including hidden ones) use the +GetAllAccessPoints() method.

@@ -84,7 +88,9 @@ GetAccessPoints (OUT ao access_points); - +

OUT ao access_points:

List of access point object paths.

+List of access point object paths. +
@@ -94,8 +100,9 @@ GetAccessPoints (OUT ao access_points); 
 GetAllAccessPoints (OUT ao access_points);
-

Get the list of all access points visible to this device, including hidden - ones for which the SSID is not yet known. +

+Get the list of all access points visible to this device, including hidden +ones for which the SSID is not yet known.

@@ -104,7 +111,9 @@ GetAllAccessPoints (OUT ao access_points); - +

OUT ao access_points:

List of access point object paths.

+List of access point object paths. +
@@ -114,7 +123,8 @@ GetAllAccessPoints (OUT ao access_points); 
 RequestScan (IN  a{sv} options);
-

Request the device to scan. To know when the scan is finished, use the "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" to listen to changes to the "LastScan" property. +

+Request the device to scan. To know when the scan is finished, use the "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" to listen to changes to the "LastScan" property.

@@ -123,7 +133,9 @@ RequestScan (IN a{sv} options); - +

IN a{sv} options:

Options of scan. Currently, 'ssids' option with value of "aay" type is supported.

+Options of scan. Currently, 'ssids' option with value of "aay" type is supported. +
@@ -135,7 +147,8 @@ RequestScan (IN a{sv} options); 
 AccessPointAdded (o access_point);
-

Emitted when a new access point is found by the device. +

+Emitted when a new access point is found by the device.

@@ -144,7 +157,9 @@ AccessPointAdded (o access_point); - +

o access_point:

The object path of the newly found access point.

+The object path of the newly found access point. +
@@ -154,7 +169,8 @@ AccessPointAdded (o access_point); 
 AccessPointRemoved (o access_point);
-

Emitted when an access point disappears from view of the device. +

+Emitted when an access point disappears from view of the device.

@@ -163,7 +179,9 @@ AccessPointRemoved (o access_point); - +

o access_point:

The object path of the access point that has disappeared.

+The object path of the access point that has disappeared. +
@@ -175,9 +193,11 @@ AccessPointRemoved (o access_point); 
 HwAddress  readable   s
-

The active hardware address of the device. +

+The active hardware address of the device.

-

DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +

+DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.

@@ -186,7 +206,8 @@ HwAddress readable s 
 PermHwAddress  readable   s
-

The permanent hardware address of the device. +

+The permanent hardware address of the device.

@@ -195,9 +216,11 @@ PermHwAddress readable s 
 Mode  readable   u
-

The operating mode of the wireless device. +

+The operating mode of the wireless device.

-

Returns: NM80211Mode +

+Returns: NM80211Mode

@@ -206,8 +229,9 @@ Mode readable u 
 Bitrate  readable   u
-

The bit rate currently used by the wireless device, in kilobits/second - (Kb/s). +

+The bit rate currently used by the wireless device, in kilobits/second +(Kb/s).

@@ -216,7 +240,8 @@ Bitrate readable u 
 AccessPoints  readable   ao
-

List of object paths of access point visible to this wireless device. +

+List of object paths of access point visible to this wireless device.

@@ -225,7 +250,8 @@ AccessPoints readable ao 
 ActiveAccessPoint  readable   o
-

Object path of the access point currently used by the wireless device. +

+Object path of the access point currently used by the wireless device.

@@ -234,9 +260,11 @@ ActiveAccessPoint readable o 
 WirelessCapabilities  readable   u
-

The capabilities of the wireless device. +

+The capabilities of the wireless device.

-

Returns: NMDeviceWifiCapabilities +

+Returns: NMDeviceWifiCapabilities

@@ -245,14 +273,15 @@ WirelessCapabilities readable u 
 LastScan  readable   x
-

The timestamp (in CLOCK_BOOTTIME milliseconds) for the last finished network scan. - A value of -1 means the device never scanned for access points. +

+The timestamp (in CLOCK_BOOTTIME milliseconds) for the last finished network scan. +A value of -1 means the device never scanned for access points.

Since 1.12

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wpan.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wpan.html index 081007a3..4415fe36 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wpan.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wpan.html @@ -8,7 +8,7 @@ - + @@ -40,7 +40,10 @@

Description

-

+

+

+

+

Property Details

@@ -49,14 +52,16 @@ 
 HwAddress  readable   s
-

The active hardware address of the device. +

+The active hardware address of the device.

-

DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. +

+DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.html index 3ef880a9..b1e492cb 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.html @@ -8,7 +8,7 @@ - + @@ -93,7 +93,10 @@

Description

-

+

+

+

+

Method Details

@@ -104,26 +107,27 @@ Reapply (IN a{sa{sv}} connection, IN t version_id, IN u flags); -

Attempts to update the configuration of a device without deactivating it. - NetworkManager has the concept of connections, which are profiles that - contain the configuration for a networking device. Those connections are - exposed via D-Bus as individual objects that can be created, modified and - deleted. When activating such a settings-connection on a device, the - settings-connection is cloned to become an applied-connection and used to - configure the device (see GetAppliedConnection). Subsequent modification - of the settings-connection don't propagate automatically to the device's - applied-connection (with exception of the firewall-zone and the metered - property). For the changes to take effect, you can either re-activate the - settings-connection, or call Reapply. The Reapply call allows you to - directly update the applied-connection and reconfigure the device. Reapply - can also be useful if the currently applied-connection is equal to the - connection that is about to be reapplied. This allows to reconfigure the - device and revert external changes like removing or adding an IP address - (which NetworkManager doesn't revert automatically because it is assumed - that the user made these changes intentionally outside of NetworkManager). - Reapply can make the applied-connection different from the - settings-connection, just like updating the settings-connection can make - them different. +

+Attempts to update the configuration of a device without deactivating it. +NetworkManager has the concept of connections, which are profiles that +contain the configuration for a networking device. Those connections are +exposed via D-Bus as individual objects that can be created, modified and +deleted. When activating such a settings-connection on a device, the +settings-connection is cloned to become an applied-connection and used to +configure the device (see GetAppliedConnection). Subsequent modification +of the settings-connection don't propagate automatically to the device's +applied-connection (with exception of the firewall-zone and the metered +property). For the changes to take effect, you can either re-activate the +settings-connection, or call Reapply. The Reapply call allows you to +directly update the applied-connection and reconfigure the device. Reapply +can also be useful if the currently applied-connection is equal to the +connection that is about to be reapplied. This allows to reconfigure the +device and revert external changes like removing or adding an IP address +(which NetworkManager doesn't revert automatically because it is assumed +that the user made these changes intentionally outside of NetworkManager). +Reapply can make the applied-connection different from the +settings-connection, just like updating the settings-connection can make +them different.

@@ -133,15 +137,21 @@ Reapply (IN a{sa{sv}} connection, - + - + - +

IN a{sa{sv}} connection:

The optional connection settings that will be reapplied on the device. If empty, the currently active settings-connection will be used. The connection cannot arbitrarily differ from the current applied-connection otherwise the call will fail. Only certain changes are supported, like adding or removing IP addresses.

+The optional connection settings that will be reapplied on the device. If empty, the currently active settings-connection will be used. The connection cannot arbitrarily differ from the current applied-connection otherwise the call will fail. Only certain changes are supported, like adding or removing IP addresses. +

IN t version_id:

If non-zero, the current version id of the applied-connection must match. The current version id can be retrieved via GetAppliedConnection. This optional argument allows to catch concurrent modifications between the GetAppliedConnection call and Reapply.

+If non-zero, the current version id of the applied-connection must match. The current version id can be retrieved via GetAppliedConnection. This optional argument allows to catch concurrent modifications between the GetAppliedConnection call and Reapply. +

IN u flags:

Flags which would modify the behavior of the Reapply call. There are no flags defined currently and the users should use the value of 0.

+Flags which would modify the behavior of the Reapply call. There are no flags defined currently and the users should use the value of 0. +
@@ -154,13 +164,14 @@ GetAppliedConnection (IN u flags, OUT a{sa{sv}} connection, OUT t version_id); -

Get the currently applied connection on the device. This is a snapshot of - the last activated connection on the device, that is the configuration - that is currently applied on the device. Usually this is the same as - GetSettings of the referenced settings connection. However, it can differ - if the settings connection was subsequently modified or the applied - connection was modified by Reapply. The applied connection is set when - activating a device or when calling Reapply. +

+Get the currently applied connection on the device. This is a snapshot of +the last activated connection on the device, that is the configuration +that is currently applied on the device. Usually this is the same as +GetSettings of the referenced settings connection. However, it can differ +if the settings connection was subsequently modified or the applied +connection was modified by Reapply. The applied connection is set when +activating a device or when calling Reapply.

@@ -170,15 +181,21 @@ GetAppliedConnection (IN u flags, - + - + - +

IN u flags:

Flags which would modify the behavior of the GetAppliedConnection call. There are no flags defined currently and the users should use the value of 0.

+Flags which would modify the behavior of the GetAppliedConnection call. There are no flags defined currently and the users should use the value of 0. +

OUT a{sa{sv}} connection:

The effective connection settings that the connection has currently applied.

+The effective connection settings that the connection has currently applied. +

OUT t version_id:

The version-id of the currently applied connection. This can be specified during Reapply to avoid races where you first fetch the applied connection, modify it and try to reapply it. If the applied connection is modified in the meantime, the version_id gets incremented and Reapply will fail.

+The version-id of the currently applied connection. This can be specified during Reapply to avoid races where you first fetch the applied connection, modify it and try to reapply it. If the applied connection is modified in the meantime, the version_id gets incremented and Reapply will fail. +
@@ -189,8 +206,9 @@ GetAppliedConnection (IN u flags, 
 Disconnect ();
-

Disconnects a device and prevents the device from automatically activating - further connections without user intervention. +

+Disconnects a device and prevents the device from automatically activating +further connections without user intervention.

@@ -199,9 +217,10 @@ Disconnect (); 
 Delete ();
-

Deletes a software device from NetworkManager and removes the interface - from the system. The method returns an error when called for a hardware - device. +

+Deletes a software device from NetworkManager and removes the interface +from the system. The method returns an error when called for a hardware +device.

@@ -214,7 +233,10 @@ StateChanged (u new_state, u old_state, u reason); -

+

+

+

+

@@ -223,15 +245,21 @@ StateChanged (u new_state, - + - + - +

u new_state:

(NMDeviceState) The new state of the device.

+(NMDeviceState) The new state of the device. +

u old_state:

(NMDeviceState) The previous state of the device.

+(NMDeviceState) The previous state of the device. +

u reason:

(NMDeviceStateReason) A reason for the state transition.

+(NMDeviceStateReason) A reason for the state transition. +
@@ -244,20 +272,22 @@ StateChanged (u new_state, 
 Udi  readable   s
-

Operating-system specific transient device hardware identifier. This is an - opaque string representing the underlying hardware for the device, and - shouldn't be used to keep track of individual devices. For some device - types (Bluetooth, Modems) it is an identifier used by the hardware service - (ie bluez or ModemManager) to refer to that device, and client programs - use it get additional information from those services which NM does not - provide. The Udi is not guaranteed to be consistent across reboots or - hotplugs of the hardware. If you're looking for a way to uniquely track - each device in your application, use the object path. If you're looking - for a way to track a specific piece of hardware across reboot or hotplug, - use a MAC address or USB serial number. +

+Operating-system specific transient device hardware identifier. This is an +opaque string representing the underlying hardware for the device, and +shouldn't be used to keep track of individual devices. For some device +types (Bluetooth, Modems) it is an identifier used by the hardware service +(ie bluez or ModemManager) to refer to that device, and client programs +use it get additional information from those services which NM does not +provide. The Udi is not guaranteed to be consistent across reboots or +hotplugs of the hardware. If you're looking for a way to uniquely track +each device in your application, use the object path. If you're looking +for a way to track a specific piece of hardware across reboot or hotplug, +use a MAC address or USB serial number.

-

Note that non-UTF-8 characters are backslash escaped. Use g_strcompress() - to obtain the true (non-UTF-8) string. +

+Note that non-UTF-8 characters are backslash escaped. Use g_strcompress() +to obtain the true (non-UTF-8) string.

@@ -266,10 +296,12 @@ Udi readable s 
 Path  readable   s
-

The path of the device as exposed by the udev property ID_PATH. +

+The path of the device as exposed by the udev property ID_PATH.

-

Note that non-UTF-8 characters are backslash escaped. Use g_strcompress() - to obtain the true (non-UTF-8) string. +

+Note that non-UTF-8 characters are backslash escaped. Use g_strcompress() +to obtain the true (non-UTF-8) string.

@@ -278,10 +310,11 @@ Path readable s 
 Interface  readable   s
-

The name of the device's control (and often data) interface. - Note that non UTF-8 characters are backslash escaped, so the - resulting name may be longer then 15 characters. Use g_strcompress() - to revert the escaping. +

+The name of the device's control (and often data) interface. +Note that non UTF-8 characters are backslash escaped, so the +resulting name may be longer then 15 characters. Use g_strcompress() +to revert the escaping.

@@ -290,13 +323,14 @@ Interface readable s 
 IpInterface  readable   s
-

The name of the device's data interface when available. This property may - not refer to the actual data interface until the device has successfully - established a data connection, indicated by the device's State becoming - ACTIVATED. - Note that non UTF-8 characters are backslash escaped, so the - resulting name may be longer then 15 characters. Use g_strcompress() - to revert the escaping. +

+The name of the device's data interface when available. This property may +not refer to the actual data interface until the device has successfully +established a data connection, indicated by the device's State becoming +ACTIVATED. +Note that non UTF-8 characters are backslash escaped, so the +resulting name may be longer then 15 characters. Use g_strcompress() +to revert the escaping.

@@ -305,9 +339,10 @@ IpInterface readable s 
 Driver  readable   s
-

The driver handling the device. - Non-UTF-8 sequences are backslash escaped. Use g_strcompress() - to revert. +

+The driver handling the device. +Non-UTF-8 sequences are backslash escaped. Use g_strcompress() +to revert.

@@ -316,9 +351,10 @@ Driver readable s 
 DriverVersion  readable   s
-

The version of the driver handling the device. - Non-UTF-8 sequences are backslash escaped. Use g_strcompress() - to revert. +

+The version of the driver handling the device. +Non-UTF-8 sequences are backslash escaped. Use g_strcompress() +to revert.

@@ -327,9 +363,10 @@ DriverVersion readable s 
 FirmwareVersion  readable   s
-

The firmware version for the device. - Non-UTF-8 sequences are backslash escaped. Use g_strcompress() - to revert. +

+The firmware version for the device. +Non-UTF-8 sequences are backslash escaped. Use g_strcompress() +to revert.

@@ -338,9 +375,11 @@ FirmwareVersion readable s 
 Capabilities  readable   u
-

Flags describing the capabilities of the device. +

+Flags describing the capabilities of the device.

-

Returns: NMDeviceCapabilities +

+Returns: NMDeviceCapabilities

@@ -349,8 +388,9 @@ Capabilities readable u 
 Ip4Address  readable   u
-

DEPRECATED; use the 'Addresses' property of the 'Ip4Config' object - instead. This property always returns 0.0.0.0 (numeric 0) as address. +

+DEPRECATED; use the 'Addresses' property of the 'Ip4Config' object +instead. This property always returns 0.0.0.0 (numeric 0) as address.

@@ -359,9 +399,11 @@ Ip4Address readable u 
 State  readable   u
-

The current state of the device. +

+The current state of the device.

-

Returns: NMDeviceState +

+Returns: NMDeviceState

@@ -370,9 +412,11 @@ State readable u 
 StateReason  readable   (uu)
-

The current state and reason for changing to that state. +

+The current state and reason for changing to that state.

-

Returns: A tuple of NMDeviceState and NMDeviceStateReason. +

+Returns: A tuple of NMDeviceState and NMDeviceStateReason.

@@ -381,10 +425,11 @@ StateReason readable (uu) 
 ActiveConnection  readable   o
-

Object path of an ActiveConnection object that "owns" this device during - activation. The ActiveConnection object tracks the life-cycle of a - connection to a specific network and implements the - org.freedesktop.NetworkManager.Connection.Active D-Bus interface. +

+Object path of an ActiveConnection object that "owns" this device during +activation. The ActiveConnection object tracks the life-cycle of a +connection to a specific network and implements the +org.freedesktop.NetworkManager.Connection.Active D-Bus interface.

@@ -393,9 +438,10 @@ ActiveConnection readable o 
 Ip4Config  readable   o
-

Object path of the Ip4Config object describing the configuration of the - device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED - state. +

+Object path of the Ip4Config object describing the configuration of the +device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED +state.

@@ -404,9 +450,10 @@ Ip4Config readable o 
 Dhcp4Config  readable   o
-

Object path of the Dhcp4Config object describing the DHCP options returned - by the DHCP server. Only valid when the device is in the - NM_DEVICE_STATE_ACTIVATED state. +

+Object path of the Dhcp4Config object describing the DHCP options returned +by the DHCP server. Only valid when the device is in the +NM_DEVICE_STATE_ACTIVATED state.

@@ -415,9 +462,10 @@ Dhcp4Config readable o 
 Ip6Config  readable   o
-

Object path of the Ip6Config object describing the configuration of the - device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED - state. +

+Object path of the Ip6Config object describing the configuration of the +device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED +state.

@@ -426,9 +474,10 @@ Ip6Config readable o 
 Dhcp6Config  readable   o
-

Object path of the Dhcp6Config object describing the DHCP options returned - by the DHCP server. Only valid when the device is in the - NM_DEVICE_STATE_ACTIVATED state. +

+Object path of the Dhcp6Config object describing the DHCP options returned +by the DHCP server. Only valid when the device is in the +NM_DEVICE_STATE_ACTIVATED state.

@@ -437,10 +486,11 @@ Dhcp6Config readable o 
 Managed  readwrite  b
-

Whether or not this device is managed by NetworkManager. Setting this - property has a similar effect to configuring the device as unmanaged via - the keyfile.unmanaged-devices setting in NetworkManager.conf. Changes to - this value are not persistent and lost after NetworkManager restart. +

+Whether or not this device is managed by NetworkManager. Setting this +property has a similar effect to configuring the device as unmanaged via +the keyfile.unmanaged-devices setting in NetworkManager.conf. Changes to +this value are not persistent and lost after NetworkManager restart.

@@ -449,11 +499,12 @@ Managed readwrite b 
 Autoconnect  readwrite  b
-

If TRUE, indicates the device is allowed to autoconnect. If FALSE, manual - intervention is required before the device will automatically connect to a - known network, such as activating a connection using the device, or - setting this property to TRUE. This property cannot be set to TRUE for - default-unmanaged devices, since they never autoconnect. +

+If TRUE, indicates the device is allowed to autoconnect. If FALSE, manual +intervention is required before the device will automatically connect to a +known network, such as activating a connection using the device, or +setting this property to TRUE. This property cannot be set to TRUE for +default-unmanaged devices, since they never autoconnect.

@@ -462,8 +513,9 @@ Autoconnect readwrite b 
 FirmwareMissing  readable   b
-

If TRUE, indicates the device is likely missing firmware necessary for its - operation. +

+If TRUE, indicates the device is likely missing firmware necessary for its +operation.

@@ -472,8 +524,9 @@ FirmwareMissing readable b 
 NmPluginMissing  readable   b
-

If TRUE, indicates the NetworkManager plugin for the device is likely - missing or misconfigured. +

+If TRUE, indicates the NetworkManager plugin for the device is likely +missing or misconfigured.

@@ -482,9 +535,11 @@ NmPluginMissing readable b 
 DeviceType  readable   u
-

The general type of the network device; ie Ethernet, Wi-Fi, etc. +

+The general type of the network device; ie Ethernet, Wi-Fi, etc.

-

Returns: NMDeviceType +

+Returns: NMDeviceType

@@ -493,8 +548,9 @@ DeviceType readable u 
 AvailableConnections  readable   ao
-

An array of object paths of every configured connection that is currently - 'available' through this device. +

+An array of object paths of every configured connection that is currently +'available' through this device.

@@ -503,10 +559,11 @@ AvailableConnections readable ao 
 PhysicalPortId  readable   s
-

If non-empty, an (opaque) indicator of the physical network port - associated with the device. This can be used to recognize when two - seemingly-separate hardware devices are actually just different virtual - interfaces to the same physical port. +

+If non-empty, an (opaque) indicator of the physical network port +associated with the device. This can be used to recognize when two +seemingly-separate hardware devices are actually just different virtual +interfaces to the same physical port.

@@ -515,7 +572,8 @@ PhysicalPortId readable s 
 Mtu  readable   u
-

The device MTU (maximum transmission unit). +

+The device MTU (maximum transmission unit).

@@ -524,10 +582,12 @@ Mtu readable u 
 Metered  readable   u
-

Whether the amount of traffic flowing through the device is subject to - limitations, for example set by service providers. +

+Whether the amount of traffic flowing through the device is subject to +limitations, for example set by service providers.

-

Returns: NMMetered +

+Returns: NMMetered

@@ -536,8 +596,9 @@ Metered readable u 
 LldpNeighbors  readable   aa{sv}
-

Array of LLDP neighbors; each element is a dictionary mapping LLDP TLV - names to variant boxed values. +

+Array of LLDP neighbors; each element is a dictionary mapping LLDP TLV +names to variant boxed values.

@@ -546,9 +607,10 @@ LldpNeighbors readable aa{sv} 
 Real  readable   b
-

True if the device exists, or False for placeholder devices that do not - yet exist but could be automatically created by NetworkManager if one of - their AvailableConnections was activated. +

+True if the device exists, or False for placeholder devices that do not +yet exist but could be automatically created by NetworkManager if one of +their AvailableConnections was activated.

@@ -557,9 +619,11 @@ Real readable b 
 Ip4Connectivity  readable   u
-

The result of the last IPv4 connectivity check. +

+The result of the last IPv4 connectivity check.

-

Returns: NMConnectivityState +

+Returns: NMConnectivityState

Since 1.16

@@ -569,9 +633,11 @@ Ip4Connectivity readable u 
 Ip6Connectivity  readable   u
-

The result of the last IPv6 connectivity check. +

+The result of the last IPv6 connectivity check.

-

Returns: NMConnectivityState +

+Returns: NMConnectivityState

Since 1.16

@@ -581,9 +647,10 @@ Ip6Connectivity readable u 
 InterfaceFlags  readable   u
-

The flags of the network interface. See - NMDeviceInterfaceFlags for - the currently defined flags. +

+The flags of the network interface. See +NMDeviceInterfaceFlags for +the currently defined flags.

Since 1.22

@@ -593,9 +660,11 @@ InterfaceFlags readable u 
 HwAddress  readable   s
-

The hardware address of the device. +

+The hardware address of the device.

-

This replaces the other 'HwAddress' properties on the device-specific D-Bus interfaces. +

+This replaces the other 'HwAddress' properties on the device-specific D-Bus interfaces.

Since 1.24

@@ -605,17 +674,19 @@ HwAddress readable s 
 Ports  readable   ao
-

The port devices of the controller device. +

+The port devices of the controller device.

-

Array of object paths representing devices which are currently set as - port of this device. This replaces the 'Slaves' properties on the - device-specific D-Bus interfaces. +

+Array of object paths representing devices which are currently set as +port of this device. This replaces the 'Slaves' properties on the +device-specific D-Bus interfaces.

Since 1.34

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.DnsManager.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.DnsManager.html index 4741a7e5..143da2a4 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.DnsManager.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.DnsManager.html @@ -8,7 +8,7 @@ - + @@ -42,7 +42,8 @@

Description

-

The interface contains DNS-related information. +

+The interface contains DNS-related information.

@@ -52,7 +53,8 @@ 
 Mode  readable   s
-

The current DNS processing mode. +

+The current DNS processing mode.

@@ -61,7 +63,8 @@ Mode readable s 
 RcManager  readable   s
-

The current resolv.conf management mode. +

+The current resolv.conf management mode.

@@ -70,18 +73,19 @@ RcManager readable s 
 Configuration  readable   aa{sv}
-

The current DNS configuration represented as an array of - dictionaries. Each dictionary has the "nameservers", - "priority" keys and, optionally, "interface" and "vpn". - "nameservers" is the list of DNS servers, "priority" their - relative priority, "interface" the interface on which these - servers are contacted, "vpn" a boolean telling whether the - configuration was obtained from a VPN connection. +

+The current DNS configuration represented as an array of +dictionaries. Each dictionary has the "nameservers", +"priority" keys and, optionally, "interface" and "vpn". +"nameservers" is the list of DNS servers, "priority" their +relative priority, "interface" the interface on which these +servers are contacted, "vpn" a boolean telling whether the +configuration was obtained from a VPN connection.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP4Config.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP4Config.html index 6906af35..ef2a7e63 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP4Config.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP4Config.html @@ -8,7 +8,7 @@ - + @@ -52,7 +52,10 @@

Description

-

+

+

+

+

Property Details

@@ -61,9 +64,10 @@ 
 Addresses  readable   aau
-

Array of arrays of IPv4 address/prefix/gateway. All 3 elements of each - array are in network byte order. Essentially: [(addr, prefix, gateway), - (addr, prefix, gateway), ...] Deprecated: use AddressData and Gateway +

+Array of arrays of IPv4 address/prefix/gateway. All 3 elements of each +array are in network byte order. Essentially: [(addr, prefix, gateway), +(addr, prefix, gateway), ...] Deprecated: use AddressData and Gateway

@@ -72,9 +76,10 @@ Addresses readable aau 
 AddressData  readable   aa{sv}
-

Array of IP address data objects. All addresses will include "address" (an - IP address string), and "prefix" (a uint). Some addresses may include - additional attributes. +

+Array of IP address data objects. All addresses will include "address" (an +IP address string), and "prefix" (a uint). Some addresses may include +additional attributes.

@@ -83,7 +88,8 @@ AddressData readable aa{sv} 
 Gateway  readable   s
-

The gateway in use. +

+The gateway in use.

@@ -92,11 +98,12 @@ Gateway readable s 
 Routes  readable   aau
-

Arrays of IPv4 route/prefix/next-hop/metric. All 4 elements of each tuple - are in network byte order. 'route' and 'next hop' are IPv4 addresses, - while prefix and metric are simple unsigned integers. Essentially: - [(route, prefix, next-hop, metric), (route, prefix, next-hop, metric), - ...] Deprecated: use RouteData +

+Arrays of IPv4 route/prefix/next-hop/metric. All 4 elements of each tuple +are in network byte order. 'route' and 'next hop' are IPv4 addresses, +while prefix and metric are simple unsigned integers. Essentially: +[(route, prefix, next-hop, metric), (route, prefix, next-hop, metric), +...] Deprecated: use RouteData

@@ -105,9 +112,10 @@ Routes readable aau 
 RouteData  readable   aa{sv}
-

Array of IP route data objects. All routes will include "dest" (an IP - address string) and "prefix" (a uint). Some routes may include "next-hop" - (an IP address string), "metric" (a uint), and additional attributes. +

+Array of IP route data objects. All routes will include "dest" (an IP +address string) and "prefix" (a uint). Some routes may include "next-hop" +(an IP address string), "metric" (a uint), and additional attributes.

@@ -116,7 +124,8 @@ RouteData readable aa{sv} 
 Nameservers  readable   au
-

The nameservers in use. Deprecated: use NameserverData +

+The nameservers in use. Deprecated: use NameserverData

@@ -125,8 +134,9 @@ Nameservers readable au 
 NameserverData  readable   aa{sv}
-

The nameservers in use. Currently, only the value "address" - is recognized (with an IP address string). +

+The nameservers in use. Currently, only the value "address" +is recognized (with an IP address string).

Since 1.14

@@ -136,7 +146,8 @@ NameserverData readable aa{sv} 
 Domains  readable   as
-

A list of domains this address belongs to. +

+A list of domains this address belongs to.

@@ -145,7 +156,8 @@ Domains readable as 
 Searches  readable   as
-

A list of dns searches. +

+A list of dns searches.

@@ -154,8 +166,9 @@ Searches readable as 
 DnsOptions  readable   as
-

A list of DNS options that modify the behavior of the DNS resolver. See - resolv.conf(5) manual page for the list of supported options. +

+A list of DNS options that modify the behavior of the DNS resolver. See +resolv.conf(5) manual page for the list of supported options.

@@ -164,7 +177,8 @@ DnsOptions readable as 
 DnsPriority  readable   i
-

The relative priority of DNS servers. +

+The relative priority of DNS servers.

@@ -173,8 +187,9 @@ DnsPriority readable i 
 WinsServers  readable   au
-

The Windows Internet Name Service servers associated with the connection. - Each address is in network byte order. Deprecated: use WinsServerData +

+The Windows Internet Name Service servers associated with the connection. +Each address is in network byte order. Deprecated: use WinsServerData

@@ -183,13 +198,14 @@ WinsServers readable au 
 WinsServerData  readable   as
-

The Windows Internet Name Service servers associated with the connection. +

+The Windows Internet Name Service servers associated with the connection.

Since 1.14

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP6Config.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP6Config.html index 3336e0c0..7b5e167e 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP6Config.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP6Config.html @@ -8,7 +8,7 @@ - + @@ -49,7 +49,10 @@

Description

-

+

+

+

+

Property Details

@@ -58,8 +61,9 @@ 
 Addresses  readable   a(ayuay)
-

Array of tuples of IPv6 address/prefix/gateway. Deprecated: use - AddressData and Gateway. +

+Array of tuples of IPv6 address/prefix/gateway. Deprecated: use +AddressData and Gateway.

@@ -68,9 +72,10 @@ Addresses readable a(ayuay) 
 AddressData  readable   aa{sv}
-

Array of IP address data objects. All addresses will include "address" (an - IP address string), and "prefix" (a uint). Some addresses may include - additional attributes. +

+Array of IP address data objects. All addresses will include "address" (an +IP address string), and "prefix" (a uint). Some addresses may include +additional attributes.

@@ -79,7 +84,8 @@ AddressData readable aa{sv} 
 Gateway  readable   s
-

The gateway in use. +

+The gateway in use.

@@ -88,7 +94,8 @@ Gateway readable s 
 Routes  readable   a(ayuayu)
-

Tuples of IPv6 route/prefix/next-hop/metric. Deprecated: use RouteData +

+Tuples of IPv6 route/prefix/next-hop/metric. Deprecated: use RouteData

@@ -97,9 +104,10 @@ Routes readable a(ayuayu) 
 RouteData  readable   aa{sv}
-

Array of IP route data objects. All routes will include "dest" (an IP - address string) and "prefix" (a uint). Some routes may include "next-hop" - (an IP address string), "metric" (a uint), and additional attributes. +

+Array of IP route data objects. All routes will include "dest" (an IP +address string) and "prefix" (a uint). Some routes may include "next-hop" +(an IP address string), "metric" (a uint), and additional attributes.

@@ -108,7 +116,8 @@ RouteData readable aa{sv} 
 Nameservers  readable   aay
-

The nameservers in use. +

+The nameservers in use.

@@ -117,7 +126,8 @@ Nameservers readable aay 
 Domains  readable   as
-

A list of domains this address belongs to. +

+A list of domains this address belongs to.

@@ -126,7 +136,8 @@ Domains readable as 
 Searches  readable   as
-

A list of dns searches. +

+A list of dns searches.

@@ -135,8 +146,9 @@ Searches readable as 
 DnsOptions  readable   as
-

A list of DNS options that modify the behavior of the DNS resolver. See - resolv.conf(5) manual page for the list of supported options. +

+A list of DNS options that modify the behavior of the DNS resolver. See +resolv.conf(5) manual page for the list of supported options.

@@ -145,12 +157,13 @@ DnsOptions readable as 
 DnsPriority  readable   i
-

The relative priority of DNS servers. +

+The relative priority of DNS servers.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.PPP.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.PPP.html index 1a357e2c..7d107f22 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.PPP.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.PPP.html @@ -8,7 +8,7 @@ - + @@ -44,7 +44,10 @@

Description

-

+

+

+

+

Method Details

@@ -54,7 +57,10 @@ NeedSecrets (OUT s username, OUT s password); -

+

+

+

+

@@ -63,11 +69,21 @@ NeedSecrets (OUT s username, - + - +

OUT s username:

 +

+

+

+

+

OUT s password:

 +

+

+

+

+
@@ -78,7 +94,10 @@ NeedSecrets (OUT s username, 
 SetIp4Config (IN  a{sv} config);
-

+

+

+

+

@@ -86,7 +105,12 @@ SetIp4Config (IN a{sv} config); - +

IN a{sv} config:

 +

+

+

+

+
@@ -96,7 +120,10 @@ SetIp4Config (IN a{sv} config); 
 SetIp6Config (IN  a{sv} config);
-

+

+

+

+

@@ -104,7 +131,12 @@ SetIp6Config (IN a{sv} config); - +

IN a{sv} config:

 +

+

+

+

+
@@ -114,7 +146,10 @@ SetIp6Config (IN a{sv} config); 
 SetState (IN  u state);
-

+

+

+

+

@@ -122,7 +157,12 @@ SetState (IN u state); - +

IN u state:

 +

+

+

+

+
@@ -132,7 +172,10 @@ SetState (IN u state); 
 SetIfindex (IN  i ifindex);
-

+

+

+

+

@@ -140,13 +183,18 @@ SetIfindex (IN i ifindex); - +

IN i ifindex:

 +

+

+

+

+
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.SecretAgent.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.SecretAgent.html index b9331beb..ae728497 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.SecretAgent.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.SecretAgent.html @@ -8,7 +8,7 @@ - + @@ -50,15 +50,16 @@

Description

-

Private D-Bus interface used by secret agents that store and provide - secrets to NetworkManager. If an agent provides secrets to NetworkManager - as part of connection creation, and the some of those secrets are "agent - owned" the agent should store those secrets itself and should not expect - its SaveSecrets() method to be called. SaveSecrets() will be called eg if - some program other than the agent itself (like a connection editor) - changes the secrets out of band. The agent should implement this D-Bus - interface on an object with the path - /org/freedesktop/NetworkManager/SecretAgent. +

+Private D-Bus interface used by secret agents that store and provide +secrets to NetworkManager. If an agent provides secrets to NetworkManager +as part of connection creation, and the some of those secrets are "agent +owned" the agent should store those secrets itself and should not expect +its SaveSecrets() method to be called. SaveSecrets() will be called eg if +some program other than the agent itself (like a connection editor) +changes the secrets out of band. The agent should implement this D-Bus +interface on an object with the path +/org/freedesktop/NetworkManager/SecretAgent.

@@ -73,13 +74,14 @@ GetSecrets (IN a{sa{sv}} connection, IN u flags, OUT a{sa{sv}} secrets); -

Retrieve and return stored secrets, if any, or request new secrets from - the agent's user. If user interaction is allowed and the user enters new - secrets, the agent is expected to save the new secrets to persistent - storage (if the secret's flags include AGENT_OWNED) as NetworkManager will - not send these secrets back to the same agent via a SaveSecrets() call. If - the user canceled any interaction, the agent should return the - UserCanceled error (see below). +

+Retrieve and return stored secrets, if any, or request new secrets from +the agent's user. If user interaction is allowed and the user enters new +secrets, the agent is expected to save the new secrets to persistent +storage (if the secret's flags include AGENT_OWNED) as NetworkManager will +not send these secrets back to the same agent via a SaveSecrets() call. If +the user canceled any interaction, the agent should return the +UserCanceled error (see below).

@@ -89,27 +91,39 @@ GetSecrets (IN a{sa{sv}} connection, - + - + - + - + - + - +

IN a{sa{sv}} connection:

Nested settings maps containing the connection for which secrets are being requested. This may contain system-owned secrets if the agent has successfully authenticated to modify system network settings and the GetSecrets request flags allow user interaction.

+Nested settings maps containing the connection for which secrets are being requested. This may contain system-owned secrets if the agent has successfully authenticated to modify system network settings and the GetSecrets request flags allow user interaction. +

IN o connection_path:

Object path of the connection for which secrets are being requested.

+Object path of the connection for which secrets are being requested. +

IN s setting_name:

Setting name for which secrets are being requested.

+Setting name for which secrets are being requested. +

IN as hints:

Array of strings of key names in the requested setting for which NetworkManager thinks a secrets may be required, and/or well-known identifiers and data that may be useful to the client in processing the secrets request. Note that it's not always possible to determine which secret is required, so in some cases no hints may be given. The Agent should return any secrets it has, or that it thinks are required, regardless of what hints NetworkManager sends in this request. Some hints have special prefixes that provide information to the agent; for example, VPN requests may send server-specific messages prefixed with "x-vpn-message:".

+Array of strings of key names in the requested setting for which NetworkManager thinks a secrets may be required, and/or well-known identifiers and data that may be useful to the client in processing the secrets request. Note that it's not always possible to determine which secret is required, so in some cases no hints may be given. The Agent should return any secrets it has, or that it thinks are required, regardless of what hints NetworkManager sends in this request. Some hints have special prefixes that provide information to the agent; for example, VPN requests may send server-specific messages prefixed with "x-vpn-message:". +

IN u flags:

(NMSecretAgentGetSecretsFlags) Flags which modify the behavior of the secrets request. If true, new secrets are assumed to be invalid or incorrect, and the agent should ask the user for new secrets. If false, existing secrets should be retrieved from storage and returned without interrupting the user.

+(NMSecretAgentGetSecretsFlags) Flags which modify the behavior of the secrets request. If true, new secrets are assumed to be invalid or incorrect, and the agent should ask the user for new secrets. If false, existing secrets should be retrieved from storage and returned without interrupting the user. +

OUT a{sa{sv}} secrets:

Nested settings maps containing secrets. Each setting MUST contain at least the 'name' field, containing the name of the setting, and one or more secrets.

+Nested settings maps containing secrets. Each setting MUST contain at least the 'name' field, containing the name of the setting, and one or more secrets. +
@@ -121,9 +135,10 @@ GetSecrets (IN a{sa{sv}} connection, CancelGetSecrets (IN o connection_path, IN s setting_name); -

Cancel a pending GetSecrets request for secrets of the given connection. - Any GetSecrets request with the same 'connection_path' and 'setting_name' - that are given in a CancelGetSecrets request should be canceled. +

+Cancel a pending GetSecrets request for secrets of the given connection. +Any GetSecrets request with the same 'connection_path' and 'setting_name' +that are given in a CancelGetSecrets request should be canceled.

@@ -133,11 +148,15 @@ CancelGetSecrets (IN o connection_path, - + - +

IN o connection_path:

Object path of the connection for which, if secrets for the given 'setting_name' are being requested, the request should be canceled.

+Object path of the connection for which, if secrets for the given 'setting_name' are being requested, the request should be canceled. +

IN s setting_name:

Setting name for which secrets for this connection were originally being requested.

+Setting name for which secrets for this connection were originally being requested. +
@@ -149,7 +168,8 @@ CancelGetSecrets (IN o connection_path, SaveSecrets (IN a{sa{sv}} connection, IN o connection_path); -

Save given secrets to backing storage. +

+Save given secrets to backing storage.

@@ -159,11 +179,15 @@ SaveSecrets (IN a{sa{sv}} connection, - + - +

IN a{sa{sv}} connection:

Nested settings maps containing the entire connection (including secrets), for which the agent should save the secrets to backing storage. This method will not be called when the agent itself is the process creating or updating a connection; in that case the agent is assumed to have already saved those secrets since it had them already.

+Nested settings maps containing the entire connection (including secrets), for which the agent should save the secrets to backing storage. This method will not be called when the agent itself is the process creating or updating a connection; in that case the agent is assumed to have already saved those secrets since it had them already. +

IN o connection_path:

Object path of the connection for which the agent should save secrets to backing storage.

+Object path of the connection for which the agent should save secrets to backing storage. +
@@ -175,7 +199,8 @@ SaveSecrets (IN a{sa{sv}} connection, DeleteSecrets (IN a{sa{sv}} connection, IN o connection_path); -

Delete secrets from backing storage. +

+Delete secrets from backing storage.

@@ -185,11 +210,15 @@ DeleteSecrets (IN a{sa{sv}} connection, - + - +

IN a{sa{sv}} connection:

Nested settings maps containing the connection properties (sans secrets), for which the agent should delete the secrets from backing storage.

+Nested settings maps containing the connection properties (sans secrets), for which the agent should delete the secrets from backing storage. +

IN o connection_path:

Object path of the connection for which the agent should delete secrets from backing storage.

+Object path of the connection for which the agent should delete secrets from backing storage. +
@@ -197,6 +226,6 @@ DeleteSecrets (IN a{sa{sv}} connection,
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html index 0c4467cb..d0b2322f 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html @@ -8,7 +8,7 @@ - + @@ -67,7 +67,8 @@

Description

-

Represents a single network connection configuration. +

+Represents a single network connection configuration.

@@ -77,11 +78,12 @@ 
 Update (IN  a{sa{sv}} properties);
-

Update the connection with new settings and properties (replacing all - previous settings and properties) and save the connection to disk. Secrets - may be part of the update request, and will be either stored in persistent - storage or sent to a Secret Agent for storage, depending on the flags - associated with each secret. +

+Update the connection with new settings and properties (replacing all +previous settings and properties) and save the connection to disk. Secrets +may be part of the update request, and will be either stored in persistent +storage or sent to a Secret Agent for storage, depending on the flags +associated with each secret.

@@ -90,7 +92,9 @@ Update (IN a{sa{sv}} properties); - +

IN a{sa{sv}} properties:

New connection settings, properties, and (optionally) secrets.

+New connection settings, properties, and (optionally) secrets. +
@@ -100,14 +104,15 @@ Update (IN a{sa{sv}} properties); 
 UpdateUnsaved (IN  a{sa{sv}} properties);
-

Update the connection with new settings and properties (replacing all - previous settings and properties) but do not immediately save the - connection to disk. Secrets may be part of the update request and may sent - to a Secret Agent for storage, depending on the flags associated with each - secret. Use the 'Save' method to save these changes to disk. Note that - unsaved changes will be lost if the connection is reloaded from disk - (either automatically on file change or due to an explicit - ReloadConnections call). +

+Update the connection with new settings and properties (replacing all +previous settings and properties) but do not immediately save the +connection to disk. Secrets may be part of the update request and may sent +to a Secret Agent for storage, depending on the flags associated with each +secret. Use the 'Save' method to save these changes to disk. Note that +unsaved changes will be lost if the connection is reloaded from disk +(either automatically on file change or due to an explicit +ReloadConnections call).

@@ -116,7 +121,9 @@ UpdateUnsaved (IN a{sa{sv}} properties); - +

IN a{sa{sv}} properties:

New connection settings, properties, and (optionally) secrets.

+New connection settings, properties, and (optionally) secrets. +
@@ -126,7 +133,8 @@ UpdateUnsaved (IN a{sa{sv}} properties); 
 Delete ();
-

Delete the connection. +

+Delete the connection.

@@ -135,10 +143,11 @@ Delete (); 
 GetSettings (OUT a{sa{sv}} settings);
-

Get the settings maps describing this network configuration. This will - never include any secrets required for connection to the network, as those - are often protected. Secrets must be requested separately using the - GetSecrets() call. +

+Get the settings maps describing this network configuration. This will +never include any secrets required for connection to the network, as those +are often protected. Secrets must be requested separately using the +GetSecrets() call.

@@ -147,7 +156,9 @@ GetSettings (OUT a{sa{sv}} settings); - +

OUT a{sa{sv}} settings:

The nested settings maps describing this object.

+The nested settings maps describing this object. +
@@ -158,10 +169,11 @@ GetSettings (OUT a{sa{sv}} settings); GetSecrets (IN s setting_name, OUT a{sa{sv}} secrets); -

Get the secrets belonging to this network configuration. Only secrets from - persistent storage or a Secret Agent running in the requestor's session - will be returned. The user will never be prompted for secrets as a result - of this request. +

+Get the secrets belonging to this network configuration. Only secrets from +persistent storage or a Secret Agent running in the requestor's session +will be returned. The user will never be prompted for secrets as a result +of this request.

@@ -171,11 +183,15 @@ GetSecrets (IN s setting_name, - + - +

IN s setting_name:

Name of the setting to return secrets for. If empty, all secrets will be returned.

+Name of the setting to return secrets for. If empty, all secrets will be returned. +

OUT a{sa{sv}} secrets:

Nested settings maps containing secrets.

+Nested settings maps containing secrets. +
@@ -186,7 +202,8 @@ GetSecrets (IN s setting_name, 
 ClearSecrets ();
-

Clear the secrets belonging to this network connection profile. +

+Clear the secrets belonging to this network connection profile.

@@ -195,8 +212,9 @@ ClearSecrets (); 
 Save ();
-

Saves a "dirty" connection (that had previously been updated with - UpdateUnsaved) to persistent storage. +

+Saves a "dirty" connection (that had previously been updated with +UpdateUnsaved) to persistent storage.

@@ -208,19 +226,23 @@ Update2 (IN a{sa{sv}} settings, IN a{sv} args, OUT a{sv} result); -

Update the connection with new settings and properties (replacing all - previous settings and properties). +

+Update the connection with new settings and properties (replacing all +previous settings and properties).

-

Update2 is an alternative to - Update, - UpdateUnsaved - and Save - extensible with extra flags and args arguments. +

+Update2 is an alternative to +Update, +UpdateUnsaved +and Save +extensible with extra flags and args arguments.

-

The flags argument accepts the combination of following values, - logically or-ed together: +

+The flags argument accepts the combination of following values, +logically or-ed together: +

+

-

@@ -234,18 +256,18 @@ Update2 (IN a{sa{sv}} settings, +profile on disk). If neither 0x1 nor 0x2 is set, the change is made in memory +only, if the connection is already in memory only.

+the profile from disk to in-memory.

+the profile from disk to in-memory.

@@ -258,15 +280,17 @@ Update2 (IN a{sa{sv}} settings, +to take effect on currently active devices.

0x2 (in-memory):

The change is only made in memory (without touching an eventual - profile on disk). If neither 0x1 nor 0x2 is set, the change is made in memory - only, if the connection is already in memory only.

0x4 (in-memory-detached):

Like "in-memory", but behaves slightly different when migrating - the profile from disk to in-memory.

0x8 (in-memory-only):

Like "in-memory", but behaves slightly different when migrating - the profile from disk to in-memory.

0x10 (volatile):

0x40 (no-reapply):

Prevents "connection.zone" and "connection.metered" properties - to take effect on currently active devices.

-

The args argument accepts the following keys: +

+The args argument accepts the following keys: +

+

-

@@ -276,16 +300,17 @@ Update2 (IN a{sa{sv}} settings,

plugin:

The settings plugin the connection will be migrated to - such as "keyfile" or "ifcfg-rh".

+such as "keyfile" or "ifcfg-rh".

Since 1.38

-

Secrets may be part of the update request, and will be either stored in persistent - storage or sent to a Secret Agent for storage, depending on the flags - associated with each secret. +

+Secrets may be part of the update request, and will be either stored in persistent +storage or sent to a Secret Agent for storage, depending on the flags +associated with each secret.

@@ -295,19 +320,27 @@ Update2 (IN a{sa{sv}} settings, - + - + - + - +

IN a{sa{sv}} settings:

New connection settings, properties, and (optionally) secrets. Provide an empty array to use the current settings.

+New connection settings, properties, and (optionally) secrets. Provide an empty array to use the current settings. +

IN u flags:

Optional flags. Unknown flags cause the call to fail.

+Optional flags. Unknown flags cause the call to fail. +

IN a{sv} args:

Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail.

+Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail. +

OUT a{sv} result:

Currently no results are returned.

+Currently no results are returned. +
@@ -321,10 +354,11 @@ Update2 (IN a{sa{sv}} settings, 
 Updated ();
-

Emitted when any settings or permissions change. When handling this - signal, clients should re-read the connection using the GetSettings method - to get the changes and to ensure the client still has permission to access - the connection. +

+Emitted when any settings or permissions change. When handling this +signal, clients should re-read the connection using the GetSettings method +to get the changes and to ensure the client still has permission to access +the connection.

@@ -333,10 +367,11 @@ Updated (); 
 Removed ();
-

Emitted when this connection is no longer available. This happens when the - connection is deleted or if it is no longer accessible by any of the - system's logged-in users. After receipt of this signal, the object no - longer exists. Also see the Settings.ConnectionRemoved signal. +

+Emitted when this connection is no longer available. This happens when the +connection is deleted or if it is no longer accessible by any of the +system's logged-in users. After receipt of this signal, the object no +longer exists. Also see the Settings.ConnectionRemoved signal.

@@ -347,10 +382,11 @@ Removed (); 
 Unsaved  readable   b
-

If set, indicates that the in-memory state of the connection does not - match the on-disk state. This flag will be set when UpdateUnsaved() is - called or when any connection details change, and cleared when the - connection is saved to disk via Save() or from internal operations. +

+If set, indicates that the in-memory state of the connection does not +match the on-disk state. This flag will be set when UpdateUnsaved() is +called or when any connection details change, and cleared when the +connection is saved to disk via Save() or from internal operations.

@@ -359,9 +395,11 @@ Unsaved readable b 
 Flags  readable   u
-

Additional flags of the connection profile. +

+Additional flags of the connection profile.

-

Returns: NMSettingsConnectionFlags +

+Returns: NMSettingsConnectionFlags

Since 1.12

@@ -371,13 +409,14 @@ Flags readable u 
 Filename  readable   s
-

File that stores the connection in case the connection is file-backed. +

+File that stores the connection in case the connection is file-backed.

Since 1.12

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html index 1d4adbea..7efdc770 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html @@ -8,7 +8,7 @@ - + @@ -72,8 +72,9 @@

Description

-

The Settings interface allows clients to view and administrate the - connections stored and used by NetworkManager. +

+The Settings interface allows clients to view and administrate the +connections stored and used by NetworkManager.

@@ -83,7 +84,8 @@ 
 ListConnections (OUT ao connections);
-

List the saved network connections known to NetworkManager. +

+List the saved network connections known to NetworkManager.

@@ -92,7 +94,9 @@ ListConnections (OUT ao connections); - +

OUT ao connections:

List of connections.

+List of connections. +
@@ -103,7 +107,8 @@ ListConnections (OUT ao connections); GetConnectionByUuid (IN s uuid, OUT o connection); -

Retrieve the object path of a connection, given that connection's UUID. +

+Retrieve the object path of a connection, given that connection's UUID.

@@ -113,11 +118,15 @@ GetConnectionByUuid (IN s uuid, - + - +

IN s uuid:

The UUID to find the connection object path for.

+The UUID to find the connection object path for. +

OUT o connection:

The connection's object path.

+The connection's object path. +
@@ -129,10 +138,11 @@ GetConnectionByUuid (IN s uuid, AddConnection (IN a{sa{sv}} connection, OUT o path); -

Add new connection and save it to disk. This operation does not start the - network connection unless (1) device is idle and able to connect to the - network described by the new connection, and (2) the connection is allowed - to be started automatically. +

+Add new connection and save it to disk. This operation does not start the +network connection unless (1) device is idle and able to connect to the +network described by the new connection, and (2) the connection is allowed +to be started automatically.

@@ -142,11 +152,15 @@ AddConnection (IN a{sa{sv}} connection, - + - +

IN a{sa{sv}} connection:

Connection settings and properties.

+Connection settings and properties. +

OUT o path:

Object path of the new connection that was just added.

+Object path of the new connection that was just added. +
@@ -158,11 +172,12 @@ AddConnection (IN a{sa{sv}} connection, AddConnectionUnsaved (IN a{sa{sv}} connection, OUT o path); -

Add new connection but do not save it to disk immediately. This operation - does not start the network connection unless (1) device is idle and able - to connect to the network described by the new connection, and (2) the - connection is allowed to be started automatically. Use the 'Save' method - on the connection to save these changes to disk. +

+Add new connection but do not save it to disk immediately. This operation +does not start the network connection unless (1) device is idle and able +to connect to the network described by the new connection, and (2) the +connection is allowed to be started automatically. Use the 'Save' method +on the connection to save these changes to disk.

@@ -172,11 +187,15 @@ AddConnectionUnsaved (IN a{sa{sv}} connection, - + - +

IN a{sa{sv}} connection:

Connection settings and properties.

+Connection settings and properties. +

OUT o path:

Object path of the new connection that was just added.

+Object path of the new connection that was just added. +
@@ -191,18 +210,22 @@ AddConnection2 (IN a{sa{sv}} settings, OUT o path, OUT a{sv} result); -

Add a new connection profile. +

+Add a new connection profile.

-

AddConnection2 is an alternative to - AddConnection and - AddConnectionUnsaved. - The new variant can do everything that the older variants could, and more. - Its behavior is extensible via extra flags and args arguments. +

+AddConnection2 is an alternative to +AddConnection and +AddConnectionUnsaved. +The new variant can do everything that the older variants could, and more. +Its behavior is extensible via extra flags and args arguments. +

+

+The flags argument accepts the combination of following values, +logically or-ed together:

-

The flags argument accepts the combination of following values, - logically or-ed together: +

-

@@ -216,8 +239,8 @@ AddConnection2 (IN a{sa{sv}} settings, +profile on disk). If neither 0x1 nor 0x2 is set, the change is made in memory +only, if the connection is already in memory only.

@@ -227,9 +250,11 @@ AddConnection2 (IN a{sa{sv}} settings,

0x2 (in-memory):

The change is only made in memory (without touching an eventual - profile on disk). If neither 0x1 nor 0x2 is set, the change is made in memory - only, if the connection is already in memory only.

0x20 (block-autoconnect):

-

The args argument accepts the following keys: +

+The args argument accepts the following keys: +

+

-

@@ -239,17 +264,18 @@ AddConnection2 (IN a{sa{sv}} settings,

plugin:

The settings plugin the newly added connection will - use, such as "keyfile" or "ifcfg-rh".

+use, such as "keyfile" or "ifcfg-rh".

Since 1.38

-

Either the flags 0x1 (to-disk) or 0x2 (in-memory) must be specified. - The effect is whether to behave like - AddConnection or - AddConnectionUnsaved. +

+Either the flags 0x1 (to-disk) or 0x2 (in-memory) must be specified. +The effect is whether to behave like +AddConnection or +AddConnectionUnsaved.

@@ -259,23 +285,33 @@ AddConnection2 (IN a{sa{sv}} settings, - + - + - + - + - +

IN a{sa{sv}} settings:

New connection settings, properties, and (optionally) secrets.

+New connection settings, properties, and (optionally) secrets. +

IN u flags:

Flags. Unknown flags cause the call to fail.

+Flags. Unknown flags cause the call to fail. +

IN a{sv} args:

Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail.

+Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail. +

OUT o path:

Object path of the new connection that was just added.

+Object path of the new connection that was just added. +

OUT a{sv} result:

Output argument, currently no additional results are returned.

+Output argument, currently no additional results are returned. +
@@ -289,15 +325,17 @@ LoadConnections (IN as filenames, OUT b status, OUT as failures); -

Loads or reloads the indicated connections from disk. You should call this - after making changes directly to an on-disk connection file to make sure - that NetworkManager sees the changes. - As with AddConnection(), this operation does not necessarily - start the network connection. +

+Loads or reloads the indicated connections from disk. You should call this +after making changes directly to an on-disk connection file to make sure +that NetworkManager sees the changes. +As with AddConnection(), this operation does not necessarily +start the network connection.

-

Note that before 1.20, NetworkManager had a bug and this status value was wrong. - It is better to assume success if the method does not return with a D-Bus error. - On top of that, you can look at failures to know whether any of the requested files failed. +

+Note that before 1.20, NetworkManager had a bug and this status value was wrong. +It is better to assume success if the method does not return with a D-Bus error. +On top of that, you can look at failures to know whether any of the requested files failed.

@@ -307,15 +345,21 @@ LoadConnections (IN as filenames, - + - + - +

IN as filenames:

Array of paths to on-disk connection profiles in directories monitored by NetworkManager.

+Array of paths to on-disk connection profiles in directories monitored by NetworkManager. +

OUT b status:

Success or failure of the operation as a whole. True if NetworkManager at least tried to load the indicated connections, even if it did not succeed. False if an error occurred before trying to load the connections (eg, permission denied).

+Success or failure of the operation as a whole. True if NetworkManager at least tried to load the indicated connections, even if it did not succeed. False if an error occurred before trying to load the connections (eg, permission denied). +

OUT as failures:

Paths of connection files that could not be loaded.

+Paths of connection files that could not be loaded. +
@@ -326,8 +370,9 @@ LoadConnections (IN as filenames, 
 ReloadConnections (OUT b status);
-

Tells NetworkManager to reload all connection files from disk, including - noticing any added or deleted connection files. +

+Tells NetworkManager to reload all connection files from disk, including +noticing any added or deleted connection files.

@@ -336,7 +381,9 @@ ReloadConnections (OUT b status); - +

OUT b status:

This always returns TRUE.

+This always returns TRUE. +
@@ -346,7 +393,8 @@ ReloadConnections (OUT b status); 
 SaveHostname (IN  s hostname);
-

Save the hostname to persistent configuration. +

+Save the hostname to persistent configuration.

@@ -355,7 +403,9 @@ SaveHostname (IN s hostname); - +

IN s hostname:

The hostname to save to persistent configuration. If blank, the persistent hostname is cleared.

+The hostname to save to persistent configuration. If blank, the persistent hostname is cleared. +
@@ -367,14 +417,15 @@ SaveHostname (IN s hostname); 
 NewConnection (o connection);
-

Emitted when a new connection has been added after NetworkManager has - started up and initialized. This signal is not emitted for connections - read while starting up, because NetworkManager's D-Bus service is only - available after all connections have been read, and to prevent spamming - listeners with too many signals at one time. To retrieve the initial - connection list, call the ListConnections() method once, and then listen - for individual Settings.NewConnection and Settings.Connection.Deleted - signals for further updates. +

+Emitted when a new connection has been added after NetworkManager has +started up and initialized. This signal is not emitted for connections +read while starting up, because NetworkManager's D-Bus service is only +available after all connections have been read, and to prevent spamming +listeners with too many signals at one time. To retrieve the initial +connection list, call the ListConnections() method once, and then listen +for individual Settings.NewConnection and Settings.Connection.Deleted +signals for further updates.

@@ -383,7 +434,9 @@ NewConnection (o connection); - +

o connection:

Object path of the new connection.

+Object path of the new connection. +
@@ -393,11 +446,12 @@ NewConnection (o connection); 
 ConnectionRemoved (o connection);
-

Emitted when a connection is no longer available. This happens when the - connection is deleted or if it is no longer accessible by any of the - system's logged-in users. After receipt of this signal, the connection no - longer exists and cannot be used. Also see the Settings.Connection.Removed - signal. +

+Emitted when a connection is no longer available. This happens when the +connection is deleted or if it is no longer accessible by any of the +system's logged-in users. After receipt of this signal, the connection no +longer exists and cannot be used. Also see the Settings.Connection.Removed +signal.

@@ -406,7 +460,9 @@ ConnectionRemoved (o connection); - +

o connection:

Object path of the removed connection.

+Object path of the removed connection. +
@@ -418,7 +474,8 @@ ConnectionRemoved (o connection); 
 Connections  readable   ao
-

List of object paths of available network connection profiles. +

+List of object paths of available network connection profiles.

@@ -427,7 +484,8 @@ Connections readable ao 
 Hostname  readable   s
-

The machine hostname stored in persistent configuration. +

+The machine hostname stored in persistent configuration.

@@ -436,12 +494,13 @@ Hostname readable s 
 CanModify  readable   b
-

If true, adding and modifying connections is supported. +

+If true, adding and modifying connections is supported.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Connection.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Connection.html index 13b806f6..6a8d73bf 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Connection.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Connection.html @@ -8,7 +8,7 @@ - + @@ -49,7 +49,8 @@

Description

-

Represents an active connection to a Virtual Private Network. +

+Represents an active connection to a Virtual Private Network.

@@ -60,7 +61,8 @@ VpnStateChanged (u state, u reason); -

Emitted when the state of the VPN connection has changed. +

+Emitted when the state of the VPN connection has changed.

@@ -70,11 +72,15 @@ VpnStateChanged (u state, - + - +

u state:

(NMVpnConnectionState) The new state of the VPN connection.

+(NMVpnConnectionState) The new state of the VPN connection. +

u reason:

(NMActiveConnectionStateReason) Reason code describing the change to the new state.

+(NMActiveConnectionStateReason) Reason code describing the change to the new state. +
@@ -87,9 +93,11 @@ VpnStateChanged (u state, 
 VpnState  readable   u
-

The VPN-specific state of the connection. +

+The VPN-specific state of the connection.

-

Returns: NMVpnConnectionState +

+Returns: NMVpnConnectionState

@@ -98,12 +106,13 @@ VpnState readable u 
 Banner  readable   s
-

The banner string of the VPN connection. +

+The banner string of the VPN connection.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Plugin.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Plugin.html index 8d245c2b..e8ddb928 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Plugin.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Plugin.html @@ -8,7 +8,7 @@ - + @@ -70,8 +70,9 @@

Description

-

This interface is provided by plugins providing VPN services to the - NetworkManager daemon. +

+This interface is provided by plugins providing VPN services to the +NetworkManager daemon.

@@ -81,8 +82,9 @@ 
 Connect (IN  a{sa{sv}} connection);
-

Tells the plugin to connect. Interactive secrets requests (eg, emitting - the SecretsRequired signal) are not allowed. +

+Tells the plugin to connect. Interactive secrets requests (eg, emitting +the SecretsRequired signal) are not allowed.

@@ -91,7 +93,9 @@ Connect (IN a{sa{sv}} connection); - +

IN a{sa{sv}} connection:

Describes the connection to be established.

+Describes the connection to be established. +
@@ -102,9 +106,10 @@ Connect (IN a{sa{sv}} connection); ConnectInteractive (IN a{sa{sv}} connection, IN a{sv} details); -

Tells the plugin to connect, allowing interactive secrets requests (eg the - plugin is allowed to emit the SecretsRequired signal if the VPN service - indicates that it needs additional secrets during the connect process). +

+Tells the plugin to connect, allowing interactive secrets requests (eg the +plugin is allowed to emit the SecretsRequired signal if the VPN service +indicates that it needs additional secrets during the connect process).

@@ -114,11 +119,15 @@ ConnectInteractive (IN a{sa{sv}} connection, - + - +

IN a{sa{sv}} connection:

Describes the connection to be established.

+Describes the connection to be established. +

IN a{sv} details:

Additional details about the Connect process.

+Additional details about the Connect process. +
@@ -130,8 +139,9 @@ ConnectInteractive (IN a{sa{sv}} connection, NeedSecrets (IN a{sa{sv}} settings, OUT s setting_name); -

Asks the plugin whether the provided connection will require secrets to - connect successfully. +

+Asks the plugin whether the provided connection will require secrets to +connect successfully.

@@ -141,11 +151,15 @@ NeedSecrets (IN a{sa{sv}} settings, - + - +

IN a{sa{sv}} settings:

Describes the connection that may need secrets.

+Describes the connection that may need secrets. +

OUT s setting_name:

The setting name within the provided connection that requires secrets, if any.

+The setting name within the provided connection that requires secrets, if any. +
@@ -156,7 +170,8 @@ NeedSecrets (IN a{sa{sv}} settings, 
 Disconnect ();
-

Disconnect the plugin. +

+Disconnect the plugin.

@@ -165,7 +180,8 @@ Disconnect (); 
 SetConfig (IN  a{sv} config);
-

Set generic connection details on the connection. +

+Set generic connection details on the connection.

@@ -174,7 +190,9 @@ SetConfig (IN a{sv} config); - +

IN a{sv} config:

Generic configuration details for the connection.

+Generic configuration details for the connection. +
@@ -184,7 +202,8 @@ SetConfig (IN a{sv} config); 
 SetIp4Config (IN  a{sv} config);
-

Set IPv4 details on the connection. +

+Set IPv4 details on the connection.

@@ -193,7 +212,9 @@ SetIp4Config (IN a{sv} config); - +

IN a{sv} config:

Ip4Config details for the connection. You must call SetConfig() before calling this.

+Ip4Config details for the connection. You must call SetConfig() before calling this. +
@@ -203,7 +224,8 @@ SetIp4Config (IN a{sv} config); 
 SetIp6Config (IN  a{sv} config);
-

Set IPv6 details on the connection. +

+Set IPv6 details on the connection.

@@ -212,7 +234,9 @@ SetIp6Config (IN a{sv} config); - +

IN a{sv} config:

Ip6Config details for the connection. You must call SetConfig() before calling this.

+Ip6Config details for the connection. You must call SetConfig() before calling this. +
@@ -222,7 +246,8 @@ SetIp6Config (IN a{sv} config); 
 SetFailure (IN  s reason);
-

Indicate a failure to the plugin. +

+Indicate a failure to the plugin.

@@ -231,7 +256,9 @@ SetFailure (IN s reason); - +

IN s reason:

The reason for the failure.

+The reason for the failure. +
@@ -241,8 +268,9 @@ SetFailure (IN s reason); 
 NewSecrets (IN  a{sa{sv}} connection);
-

Called in response to a SecretsRequired signal to deliver updated secrets - or other information to the plugin. +

+Called in response to a SecretsRequired signal to deliver updated secrets +or other information to the plugin.

@@ -251,7 +279,9 @@ NewSecrets (IN a{sa{sv}} connection); - +

IN a{sa{sv}} connection:

Describes the connection including the new secrets.

+Describes the connection including the new secrets. +
@@ -263,7 +293,8 @@ NewSecrets (IN a{sa{sv}} connection); 
 StateChanged (u state);
-

Emitted when the plugin state changes. +

+Emitted when the plugin state changes.

@@ -272,7 +303,9 @@ StateChanged (u state); - +

u state:

(NMVpnServiceState) The new state of the plugin.

+(NMVpnServiceState) The new state of the plugin. +
@@ -283,9 +316,10 @@ StateChanged (u state); SecretsRequired (s message, as secrets); -

Emitted during an ongoing ConnectInteractive() request when the plugin has - determined that new secrets are required. NetworkManager will then call - the NewSecrets() method with a connection hash including the new secrets. +

+Emitted during an ongoing ConnectInteractive() request when the plugin has +determined that new secrets are required. NetworkManager will then call +the NewSecrets() method with a connection hash including the new secrets.

@@ -295,11 +329,15 @@ SecretsRequired (s message, - + - +

s message:

Informational message, if any, about the request. For example, if a second PIN is required, could indicate to the user to wait for the token code to change until entering the next PIN.

+Informational message, if any, about the request. For example, if a second PIN is required, could indicate to the user to wait for the token code to change until entering the next PIN. +

as secrets:

Array of strings of VPN secret names which the plugin thinks secrets may be required for, or other VPN-specific data to be processed by the VPN's front-end.

+Array of strings of VPN secret names which the plugin thinks secrets may be required for, or other VPN-specific data to be processed by the VPN's front-end. +
@@ -310,7 +348,8 @@ SecretsRequired (s message, 
 Config (a{sv} config);
-

The plugin obtained generic configuration information. +

+The plugin obtained generic configuration information.

@@ -319,7 +358,9 @@ Config (a{sv} config); - +

a{sv} config:

The configuration information.

+The configuration information. +
@@ -329,7 +370,8 @@ Config (a{sv} config); 
 Ip4Config (a{sv} ip4config);
-

The plugin obtained an IPv4 configuration. +

+The plugin obtained an IPv4 configuration.

@@ -338,7 +380,9 @@ Ip4Config (a{sv} ip4config); - +

a{sv} ip4config:

The IPv4 configuration.

+The IPv4 configuration. +
@@ -348,7 +392,8 @@ Ip4Config (a{sv} ip4config); 
 Ip6Config (a{sv} ip6config);
-

The plugin obtained an IPv6 configuration. +

+The plugin obtained an IPv6 configuration.

@@ -357,7 +402,9 @@ Ip6Config (a{sv} ip6config); - +

a{sv} ip6config:

The IPv6 configuration.

+The IPv6 configuration. +
@@ -367,7 +414,8 @@ Ip6Config (a{sv} ip6config); 
 LoginBanner (s banner);
-

Emitted when the plugin receives a login banner from the VPN service. +

+Emitted when the plugin receives a login banner from the VPN service.

@@ -376,7 +424,9 @@ LoginBanner (s banner); - +

s banner:

The login banner string.

+The login banner string. +
@@ -386,7 +436,8 @@ LoginBanner (s banner); 
 Failure (u reason);
-

Emitted when a failure in the VPN plugin occurs. +

+Emitted when a failure in the VPN plugin occurs.

@@ -395,7 +446,9 @@ Failure (u reason); - +

u reason:

(NMVpnPluginFailure) Reason code for the failure.

+(NMVpnPluginFailure) Reason code for the failure. +
@@ -407,14 +460,16 @@ Failure (u reason); 
 State  readable   u
-

The state of the plugin. +

+The state of the plugin.

-

Returns: NMVpnServiceState +

+Returns: NMVpnServiceState

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.WifiP2PPeer.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.WifiP2PPeer.html index 84e1beb6..80f00881 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.WifiP2PPeer.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.WifiP2PPeer.html @@ -8,7 +8,7 @@ - + @@ -49,7 +49,10 @@

Description

-

+

+

+

+

Since 1.16

@@ -59,7 +62,8 @@ 
 Name  readable   s
-

Device name. +

+Device name.

Since 1.16

@@ -69,9 +73,11 @@ Name readable s 
 Flags  readable   u
-

Flags describing the capabilities of the access point. +

+Flags describing the capabilities of the access point.

-

Returns: NM80211ApFlags +

+Returns: NM80211ApFlags

Since 1.16

@@ -81,7 +87,8 @@ Flags readable u 
 Manufacturer  readable   s
-

The manufacturer of the Wi-Fi P2P peer. +

+The manufacturer of the Wi-Fi P2P peer.

Since 1.16

@@ -91,7 +98,8 @@ Manufacturer readable s 
 Model  readable   s
-

The model of the Wi-Fi P2P peer. +

+The model of the Wi-Fi P2P peer.

Since 1.16

@@ -101,7 +109,8 @@ Model readable s 
 ModelNumber  readable   s
-

The model number of the Wi-Fi P2P peer. +

+The model number of the Wi-Fi P2P peer.

Since 1.16

@@ -111,7 +120,8 @@ ModelNumber readable s 
 Serial  readable   s
-

The serial number of the Wi-Fi P2P peer. +

+The serial number of the Wi-Fi P2P peer.

Since 1.16

@@ -121,7 +131,8 @@ Serial readable s 
 WfdIEs  readable   ay
-

The Wi-Fi Display Information Elements of the Wi-Fi P2P peer. +

+The Wi-Fi Display Information Elements of the Wi-Fi P2P peer.

Since 1.16

@@ -131,7 +142,8 @@ WfdIEs readable ay 
 HwAddress  readable   s
-

The hardware address (BSSID) of the access point. +

+The hardware address (BSSID) of the access point.

Since 1.16

@@ -141,7 +153,8 @@ HwAddress readable s 
 Strength  readable   y
-

The current signal quality of the access point, in percent. +

+The current signal quality of the access point, in percent.

Since 1.16

@@ -151,15 +164,16 @@ Strength readable y 
 LastSeen  readable   i
-

The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access - point was found in scan results. A value of -1 means the access point has - never been found in scan results. +

+The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access +point was found in scan results. A value of -1 means the access point has +never been found in scan results.

Since 1.16

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.html index f19837a3..628636fd 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.html @@ -8,7 +8,7 @@ - + @@ -119,7 +119,10 @@

Description

-

+

+

+

+

Method Details

@@ -128,26 +131,28 @@ 
 Reload (IN  u flags);
-

Reload NetworkManager's configuration and perform certain updates, like flushing a cache or - rewriting external state to disk. This is similar to sending SIGHUP to NetworkManager but it - allows for more fine-grained control over what to reload (see flags). It also allows - non-root access via PolicyKit and contrary to signals it is synchronous. +

+Reload NetworkManager's configuration and perform certain updates, like flushing a cache or +rewriting external state to disk. This is similar to sending SIGHUP to NetworkManager but it +allows for more fine-grained control over what to reload (see flags). It also allows +non-root access via PolicyKit and contrary to signals it is synchronous.

-

No flags (0x00) means to reload everything that is supported which is identical to - sending a SIGHUP. - (0x01) means to reload the NetworkManager.conf configuration from disk. Note that this - does not include connections, which can be reloaded via Setting's ReloadConnections. - (0x02) means to update DNS configuration, which usually involves writing /etc/resolv.conf - anew. - (0x04) means to restart the DNS plugin. This is for example useful when using - dnsmasq plugin, which uses additional configuration in /etc/NetworkManager/dnsmasq.d. - If you edit those files, you can restart the DNS plugin. This action shortly interrupts - name resolution. - Note that flags may affect each other. For example, restarting the DNS plugin (0x04) - implicitly updates DNS too (0x02). Or when reloading the configuration (0x01), changes - to DNS setting also cause a DNS update (0x02). However, (0x01) does not involve restarting - the DNS plugin (0x04) or update resolv.conf (0x02), unless the DNS related configuration - changes in NetworkManager.conf. +

+No flags (0x00) means to reload everything that is supported which is identical to +sending a SIGHUP. +(0x01) means to reload the NetworkManager.conf configuration from disk. Note that this +does not include connections, which can be reloaded via Setting's ReloadConnections. +(0x02) means to update DNS configuration, which usually involves writing /etc/resolv.conf +anew. +(0x04) means to restart the DNS plugin. This is for example useful when using +dnsmasq plugin, which uses additional configuration in /etc/NetworkManager/dnsmasq.d. +If you edit those files, you can restart the DNS plugin. This action shortly interrupts +name resolution. +Note that flags may affect each other. For example, restarting the DNS plugin (0x04) +implicitly updates DNS too (0x02). Or when reloading the configuration (0x01), changes +to DNS setting also cause a DNS update (0x02). However, (0x01) does not involve restarting +the DNS plugin (0x04) or update resolv.conf (0x02), unless the DNS related configuration +changes in NetworkManager.conf.

@@ -156,7 +161,9 @@ Reload (IN u flags); - +

IN u flags:

Optional flags to specify which parts shall be reloaded.

+Optional flags to specify which parts shall be reloaded. +
@@ -166,7 +173,8 @@ Reload (IN u flags); 
 GetDevices (OUT ao devices);
-

Get the list of realized network devices. +

+Get the list of realized network devices.

@@ -175,7 +183,9 @@ GetDevices (OUT ao devices); - +

OUT ao devices:

List of object paths of network devices known to the system. This list does not include device placeholders (see GetAllDevices()).

+List of object paths of network devices known to the system. This list does not include device placeholders (see GetAllDevices()). +
@@ -185,7 +195,8 @@ GetDevices (OUT ao devices); 
 GetAllDevices (OUT ao devices);
-

Get the list of all network devices. +

+Get the list of all network devices.

@@ -194,7 +205,9 @@ GetAllDevices (OUT ao devices); - +

OUT ao devices:

List of object paths of network devices and device placeholders (eg, devices that do not yet exist but which can be automatically created by NetworkManager if one of their AvailableConnections was activated).

+List of object paths of network devices and device placeholders (eg, devices that do not yet exist but which can be automatically created by NetworkManager if one of their AvailableConnections was activated). +
@@ -205,9 +218,10 @@ GetAllDevices (OUT ao devices); GetDeviceByIpIface (IN s iface, OUT o device); -

Return the object path of the network device referenced by its IP - interface name. Note that some devices (usually modems) only have an IP - interface name when they are connected. +

+Return the object path of the network device referenced by its IP +interface name. Note that some devices (usually modems) only have an IP +interface name when they are connected.

@@ -217,11 +231,15 @@ GetDeviceByIpIface (IN s iface, - + - +

IN s iface:

Interface name of the device to find.

+Interface name of the device to find. +

OUT o device:

Object path of the network device.

+Object path of the network device. +
@@ -235,7 +253,8 @@ ActivateConnection (IN o connection, IN o specific_object, OUT o active_connection); -

Activate a connection using the supplied device. +

+Activate a connection using the supplied device.

@@ -245,19 +264,27 @@ ActivateConnection (IN o connection, - + - + - + - +

IN o connection:

The connection to activate. If "/" is given, a valid device path must be given, and NetworkManager picks the best connection to activate for the given device. VPN connections must always pass a valid connection path.

+The connection to activate. If "/" is given, a valid device path must be given, and NetworkManager picks the best connection to activate for the given device. VPN connections must always pass a valid connection path. +

IN o device:

The object path of device to be activated for physical connections. This parameter is ignored for VPN connections, because the specific_object (if provided) specifies the device to use.

+The object path of device to be activated for physical connections. This parameter is ignored for VPN connections, because the specific_object (if provided) specifies the device to use. +

IN o specific_object:

The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For Wi-Fi connections, pass the object path of a specific AP from the card's scan list, or "/" to pick an AP automatically. For VPN connections, pass the object path of an ActiveConnection object that should serve as the "base" connection (to which the VPN connections lifetime will be tied), or pass "/" and NM will automatically use the current default device.

+The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For Wi-Fi connections, pass the object path of a specific AP from the card's scan list, or "/" to pick an AP automatically. For VPN connections, pass the object path of an ActiveConnection object that should serve as the "base" connection (to which the VPN connections lifetime will be tied), or pass "/" and NM will automatically use the current default device. +

OUT o active_connection:

The path of the active connection object representing this active connection.

+The path of the active connection object representing this active connection. +
@@ -272,12 +299,14 @@ AddAndActivateConnection (IN a{sa{sv}} connection, OUT o path, OUT o active_connection); -

Adds a new connection using the given details (if any) as a template - (automatically filling in missing settings with the capabilities of the - given device and specific object), then activate the new connection. - Cannot be used for VPN connections at this time. +

+Adds a new connection using the given details (if any) as a template +(automatically filling in missing settings with the capabilities of the +given device and specific object), then activate the new connection. +Cannot be used for VPN connections at this time.

-

See also AddAndActivateConnection2. +

+See also AddAndActivateConnection2.

@@ -287,23 +316,33 @@ AddAndActivateConnection (IN a{sa{sv}} connection, - + - + - + - + - +

IN a{sa{sv}} connection:

Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object.

+Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object. +

IN o device:

The object path of device to be activated using the given connection.

+The object path of device to be activated using the given connection. +

IN o specific_object:

The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For Wi-Fi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection.

+The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For Wi-Fi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection. +

OUT o path:

Object path of the new connection that was just added.

+Object path of the new connection that was just added. +

OUT o active_connection:

The path of the active connection object representing this active connection.

+The path of the active connection object representing this active connection. +
@@ -320,16 +359,19 @@ AddAndActivateConnection2 (IN a{sa{sv}} connection, OUT o active_connection, OUT a{sv} result); -

Adds a new connection using the given details (if any) as a template - (automatically filling in missing settings with the capabilities of the - given device and specific object), then activate the new connection. - Cannot be used for VPN connections at this time. +

+Adds a new connection using the given details (if any) as a template +(automatically filling in missing settings with the capabilities of the +given device and specific object), then activate the new connection. +Cannot be used for VPN connections at this time.

-

This method extends AddAndActivateConnection to allow passing further - parameters. At this time the following options are supported: +

+This method extends AddAndActivateConnection to allow passing further +parameters. At this time the following options are supported:

-

* persist: A string value of either "disk" (default), "memory" or "volatile". If "memory" is passed, the connection will not be saved to disk. If "volatile" is passed, the connection will not be saved to disk and will be destroyed when disconnected. - * bind-activation: Bind the activation lifetime. Set to "dbus-name" to automatically disconnect when the requesting process disappears from the bus. The default of "none" means the connection is kept activated normally. +

+* persist: A string value of either "disk" (default), "memory" or "volatile". If "memory" is passed, the connection will not be saved to disk. If "volatile" is passed, the connection will not be saved to disk and will be destroyed when disconnected. +* bind-activation: Bind the activation lifetime. Set to "dbus-name" to automatically disconnect when the requesting process disappears from the bus. The default of "none" means the connection is kept activated normally.

@@ -339,31 +381,45 @@ AddAndActivateConnection2 (IN a{sa{sv}} connection, - + - + - + - + - + - + - +

IN a{sa{sv}} connection:

Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object.

+Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object. +

IN o device:

The object path of device to be activated using the given connection.

+The object path of device to be activated using the given connection. +

IN o specific_object:

The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For Wi-Fi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection.

+The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For Wi-Fi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection. +

IN a{sv} options:

Further options for the method call.

+Further options for the method call. +

OUT o path:

Object path of the new connection that was just added.

+Object path of the new connection that was just added. +

OUT o active_connection:

The path of the active connection object representing this active connection.

+The path of the active connection object representing this active connection. +

OUT a{sv} result:

A dictionary of additional output arguments for future extension. Currently, not additional output arguments are supported.

+A dictionary of additional output arguments for future extension. Currently, not additional output arguments are supported. +
@@ -374,7 +430,8 @@ AddAndActivateConnection2 (IN a{sa{sv}} connection, 
 DeactivateConnection (IN  o active_connection);
-

Deactivate an active connection. +

+Deactivate an active connection.

@@ -383,7 +440,9 @@ DeactivateConnection (IN o active_connection); - +

IN o active_connection:

The currently active connection to deactivate.

+The currently active connection to deactivate. +
@@ -393,10 +452,11 @@ DeactivateConnection (IN o active_connection); 
 Sleep (IN  b sleep);
-

Control the NetworkManager daemon's sleep state. When asleep, all - interfaces that it manages are deactivated. When awake, devices are - available to be activated. This command should not be called directly by - users or clients; it is intended for system suspend/resume tracking. +

+Control the NetworkManager daemon's sleep state. When asleep, all +interfaces that it manages are deactivated. When awake, devices are +available to be activated. This command should not be called directly by +users or clients; it is intended for system suspend/resume tracking.

@@ -405,7 +465,9 @@ Sleep (IN b sleep); - +

IN b sleep:

Indicates whether the NetworkManager daemon should sleep or wake.

+Indicates whether the NetworkManager daemon should sleep or wake. +
@@ -415,11 +477,12 @@ Sleep (IN b sleep); 
 Enable (IN  b enable);
-

Control whether overall networking is enabled or disabled. When disabled, - all interfaces that NM manages are deactivated. When enabled, all managed - interfaces are re-enabled and available to be activated. This command - should be used by clients that provide to users the ability to - enable/disable all networking. +

+Control whether overall networking is enabled or disabled. When disabled, +all interfaces that NM manages are deactivated. When enabled, all managed +interfaces are re-enabled and available to be activated. This command +should be used by clients that provide to users the ability to +enable/disable all networking.

@@ -428,7 +491,9 @@ Enable (IN b enable); - +

IN b enable:

If FALSE, indicates that all networking should be disabled. If TRUE, indicates that NetworkManager should begin managing network devices.

+If FALSE, indicates that all networking should be disabled. If TRUE, indicates that NetworkManager should begin managing network devices. +
@@ -438,9 +503,10 @@ Enable (IN b enable); 
 GetPermissions (OUT a{ss} permissions);
-

Returns the permissions a caller has for various authenticated operations - that NetworkManager provides, like Enable/Disable networking, changing - Wi-Fi, WWAN, and WiMAX state, etc. +

+Returns the permissions a caller has for various authenticated operations +that NetworkManager provides, like Enable/Disable networking, changing +Wi-Fi, WWAN, and WiMAX state, etc.

@@ -449,7 +515,9 @@ GetPermissions (OUT a{ss} permissions); - +

OUT a{ss} permissions:

Dictionary of available permissions and results. Each permission is represented by a name (ie "org.freedesktop.NetworkManager.Foobar") and each result is one of the following values: "yes" (the permission is available), "auth" (the permission is available after a successful authentication), or "no" (the permission is denied). Clients may use these values in the UI to indicate the ability to perform certain operations.

+Dictionary of available permissions and results. Each permission is represented by a name (ie "org.freedesktop.NetworkManager.Foobar") and each result is one of the following values: "yes" (the permission is available), "auth" (the permission is available after a successful authentication), or "no" (the permission is denied). Clients may use these values in the UI to indicate the ability to perform certain operations. +
@@ -460,7 +528,8 @@ GetPermissions (OUT a{ss} permissions); SetLogging (IN s level, IN s domains); -

Set logging verbosity and which operations are logged. +

+Set logging verbosity and which operations are logged.

@@ -470,11 +539,15 @@ SetLogging (IN s level, - + - +

IN s level:

One of [ERR, WARN, INFO, DEBUG, TRACE, OFF, KEEP]. This level is applied to the domains as specified in the domains argument. Except for the special level "KEEP", all unmentioned domains are disabled entirely. "KEEP" is special and allows not to change the current setting except for the specified domains. E.g. level=KEEP and domains=PLATFORM:DEBUG will only touch the platform domain.

+One of [ERR, WARN, INFO, DEBUG, TRACE, OFF, KEEP]. This level is applied to the domains as specified in the domains argument. Except for the special level "KEEP", all unmentioned domains are disabled entirely. "KEEP" is special and allows not to change the current setting except for the specified domains. E.g. level=KEEP and domains=PLATFORM:DEBUG will only touch the platform domain. +

IN s domains:

A combination of logging domains separated by commas (','), or "NONE" to disable logging. Each domain enables logging for operations related to that domain. Available domains are: [PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, TEAM, CONCHECK, DCB, DISPATCH, AUDIT]. In addition to these domains, the following special domains can be used: [NONE, ALL, DEFAULT, DHCP, IP]. You can also specify that some domains should log at a different level from the default by appending a colon (':') and a log level (eg, 'WIFI:DEBUG'). If an empty string is given, the log level is changed but the current set of log domains remains unchanged.

+A combination of logging domains separated by commas (','), or "NONE" to disable logging. Each domain enables logging for operations related to that domain. Available domains are: [PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, TEAM, CONCHECK, DCB, DISPATCH, AUDIT]. In addition to these domains, the following special domains can be used: [NONE, ALL, DEFAULT, DHCP, IP]. You can also specify that some domains should log at a different level from the default by appending a colon (':') and a log level (eg, 'WIFI:DEBUG'). If an empty string is given, the log level is changed but the current set of log domains remains unchanged. +
@@ -486,7 +559,8 @@ SetLogging (IN s level, GetLogging (OUT s level, OUT s domains); -

Get current logging verbosity level and operations domains. +

+Get current logging verbosity level and operations domains.

@@ -496,11 +570,15 @@ GetLogging (OUT s level, - + - +

OUT s level:

One of [ERR, WARN, INFO, DEBUG, TRACE].

+One of [ERR, WARN, INFO, DEBUG, TRACE]. +

OUT s domains:

For available domains see SetLogging() call.

+For available domains see SetLogging() call. +
@@ -511,7 +589,8 @@ GetLogging (OUT s level, 
 CheckConnectivity (OUT u connectivity);
-

Re-check the network connectivity state. +

+Re-check the network connectivity state.

@@ -520,7 +599,9 @@ CheckConnectivity (OUT u connectivity); - +

OUT u connectivity:

(NMConnectivityState) The current connectivity state.

+(NMConnectivityState) The current connectivity state. +
@@ -530,8 +611,9 @@ CheckConnectivity (OUT u connectivity); 
 state (OUT u state);
-

The overall networking state as determined by the NetworkManager daemon, - based on the state of network devices under its management. +

+The overall networking state as determined by the NetworkManager daemon, +based on the state of network devices under its management.

@@ -540,7 +622,9 @@ state (OUT u state); - +

OUT u state:

NMState

+NMState +
@@ -553,9 +637,10 @@ CheckpointCreate (IN ao devices, IN u flags, OUT o checkpoint); -

Create a checkpoint of the current networking configuration - for given interfaces. If rollback_timeout is not zero, a - rollback is automatically performed after the given timeout. +

+Create a checkpoint of the current networking configuration +for given interfaces. If rollback_timeout is not zero, a +rollback is automatically performed after the given timeout.

@@ -565,19 +650,27 @@ CheckpointCreate (IN ao devices, - + - + - + - +

IN ao devices:

A list of device paths for which a checkpoint should be created. An empty list means all devices.

+A list of device paths for which a checkpoint should be created. An empty list means all devices. +

IN u rollback_timeout:

The time in seconds until NetworkManager will automatically rollback to the checkpoint. Set to zero for infinite.

+The time in seconds until NetworkManager will automatically rollback to the checkpoint. Set to zero for infinite. +

IN u flags:

(NMCheckpointCreateFlags) Flags for the creation.

+(NMCheckpointCreateFlags) Flags for the creation. +

OUT o checkpoint:

On success, the path of the new checkpoint.

+On success, the path of the new checkpoint. +
@@ -588,7 +681,8 @@ CheckpointCreate (IN ao devices, 
 CheckpointDestroy (IN  o checkpoint);
-

Destroy a previously created checkpoint. +

+Destroy a previously created checkpoint.

@@ -597,7 +691,9 @@ CheckpointDestroy (IN o checkpoint); - +

IN o checkpoint:

The checkpoint to be destroyed. Set to empty to cancel all pending checkpoints.

+The checkpoint to be destroyed. Set to empty to cancel all pending checkpoints. +
@@ -608,7 +704,8 @@ CheckpointDestroy (IN o checkpoint); CheckpointRollback (IN o checkpoint, OUT a{su} result); -

Rollback a checkpoint before the timeout is reached. +

+Rollback a checkpoint before the timeout is reached.

@@ -618,11 +715,15 @@ CheckpointRollback (IN o checkpoint, - + - +

IN o checkpoint:

The checkpoint to be rolled back.

+The checkpoint to be rolled back. +

OUT a{su} result:

On return, a dictionary of devices and results. Devices are represented by their original D-Bus path; each result is a RollbackResult.

+On return, a dictionary of devices and results. Devices are represented by their original D-Bus path; each result is a RollbackResult. +
@@ -634,15 +735,17 @@ CheckpointRollback (IN o checkpoint, CheckpointAdjustRollbackTimeout (IN o checkpoint, IN u add_timeout); -

Reset the timeout for rollback for the checkpoint. +

+Reset the timeout for rollback for the checkpoint.

-

Note that the added seconds start counting from now, - not "Created" timestamp or the previous expiration - time. Note that the "Created" property of the checkpoint - will stay unchanged by this call. However, the "RollbackTimeout" - will be recalculated to give the approximate new expiration time. - The new "RollbackTimeout" property will be approximate up to - one second precision, which is the accuracy of the property. +

+Note that the added seconds start counting from now, +not "Created" timestamp or the previous expiration +time. Note that the "Created" property of the checkpoint +will stay unchanged by this call. However, the "RollbackTimeout" +will be recalculated to give the approximate new expiration time. +The new "RollbackTimeout" property will be approximate up to +one second precision, which is the accuracy of the property.

@@ -652,11 +755,15 @@ CheckpointAdjustRollbackTimeout (IN o checkpoint, - + - +

IN o checkpoint:

The checkpoint to be rolled back.

+The checkpoint to be rolled back. +

IN u add_timeout:

Number of seconds from now in which the timeout will expire. Set to 0 to disable the timeout.

+Number of seconds from now in which the timeout will expire. Set to 0 to disable the timeout. +
@@ -670,8 +777,9 @@ CheckpointAdjustRollbackTimeout (IN o checkpoint, 
 CheckPermissions ();
-

Emitted when system authorization details change, indicating that clients - may wish to recheck permissions with GetPermissions. +

+Emitted when system authorization details change, indicating that clients +may wish to recheck permissions with GetPermissions.

@@ -680,7 +788,8 @@ CheckPermissions (); 
 StateChanged (u state);
-

NetworkManager's state changed. +

+NetworkManager's state changed.

@@ -689,7 +798,9 @@ StateChanged (u state); - +

u state:

(NMState) The new state of NetworkManager.

+(NMState) The new state of NetworkManager. +
@@ -699,7 +810,8 @@ StateChanged (u state); 
 DeviceAdded (o device_path);
-

A device was added to the system +

+A device was added to the system

@@ -708,7 +820,9 @@ DeviceAdded (o device_path); - +

o device_path:

The object path of the newly added device.

+The object path of the newly added device. +
@@ -718,7 +832,8 @@ DeviceAdded (o device_path); 
 DeviceRemoved (o device_path);
-

A device was removed from the system, and is no longer available. +

+A device was removed from the system, and is no longer available.

@@ -727,7 +842,9 @@ DeviceRemoved (o device_path); - +

o device_path:

The object path of the device that was just removed.

+The object path of the device that was just removed. +
@@ -739,9 +856,10 @@ DeviceRemoved (o device_path); 
 Devices  readable   ao
-

The list of realized network devices. Realized devices are those which - have backing resources (eg from the kernel or a management daemon like - ModemManager, teamd, etc). +

+The list of realized network devices. Realized devices are those which +have backing resources (eg from the kernel or a management daemon like +ModemManager, teamd, etc).

@@ -750,9 +868,10 @@ Devices readable ao 
 AllDevices  readable   ao
-

The list of both realized and un-realized network devices. Un-realized - devices are software devices which do not yet have backing resources, but - for which backing resources can be created if the device is activated. +

+The list of both realized and un-realized network devices. Un-realized +devices are software devices which do not yet have backing resources, but +for which backing resources can be created if the device is activated.

@@ -761,7 +880,8 @@ AllDevices readable ao 
 Checkpoints  readable   ao
-

The list of active checkpoints. +

+The list of active checkpoints.

@@ -770,8 +890,9 @@ Checkpoints readable ao 
 NetworkingEnabled  readable   b
-

Indicates if overall networking is currently enabled or not. See the - Enable() method. +

+Indicates if overall networking is currently enabled or not. See the +Enable() method.

@@ -780,7 +901,8 @@ NetworkingEnabled readable b 
 WirelessEnabled  readwrite  b
-

Indicates if wireless is currently enabled or not. +

+Indicates if wireless is currently enabled or not.

@@ -789,8 +911,9 @@ WirelessEnabled readwrite b 
 WirelessHardwareEnabled  readable   b
-

Indicates if the wireless hardware is currently enabled, i.e. the state of - the RF kill switch. +

+Indicates if the wireless hardware is currently enabled, i.e. the state of +the RF kill switch.

@@ -799,7 +922,8 @@ WirelessHardwareEnabled readable b 
 WwanEnabled  readwrite  b
-

Indicates if mobile broadband devices are currently enabled or not. +

+Indicates if mobile broadband devices are currently enabled or not.

@@ -808,8 +932,9 @@ WwanEnabled readwrite b 
 WwanHardwareEnabled  readable   b
-

Indicates if the mobile broadband hardware is currently enabled, i.e. the - state of the RF kill switch. +

+Indicates if the mobile broadband hardware is currently enabled, i.e. the +state of the RF kill switch.

@@ -818,8 +943,9 @@ WwanHardwareEnabled readable b 
 WimaxEnabled  readwrite  b
-

DEPRECATED. Doesn't have any meaning and is around only for - compatibility reasons. +

+DEPRECATED. Doesn't have any meaning and is around only for +compatibility reasons.

@@ -828,8 +954,9 @@ WimaxEnabled readwrite b 
 WimaxHardwareEnabled  readable   b
-

DEPRECATED. Doesn't have any meaning and is around only for - compatibility reasons. +

+DEPRECATED. Doesn't have any meaning and is around only for +compatibility reasons.

@@ -838,8 +965,9 @@ WimaxHardwareEnabled readable b 
 RadioFlags  readable   u
-

Flags related to radio devices. See NMRadioFlags for the list of flags - supported. +

+Flags related to radio devices. See NMRadioFlags for the list of flags +supported.

Since 1.38

@@ -849,7 +977,8 @@ RadioFlags readable u 
 ActiveConnections  readable   ao
-

List of active connection object paths. +

+List of active connection object paths.

@@ -858,11 +987,12 @@ ActiveConnections readable ao 
 PrimaryConnection  readable   o
-

The object path of the "primary" active connection being used to access - the network. In particular, if there is no VPN active, or the VPN does not - have the default route, then this indicates the connection that has the - default route. If there is a VPN active with the default route, then this - indicates the connection that contains the route to the VPN endpoint. +

+The object path of the "primary" active connection being used to access +the network. In particular, if there is no VPN active, or the VPN does not +have the default route, then this indicates the connection that has the +default route. If there is a VPN active with the default route, then this +indicates the connection that contains the route to the VPN endpoint.

@@ -871,9 +1001,10 @@ PrimaryConnection readable o 
 PrimaryConnectionType  readable   s
-

The connection type of the "primary" active connection being used to - access the network. This is the same as the Type property on the object - indicated by PrimaryConnection. +

+The connection type of the "primary" active connection being used to +access the network. This is the same as the Type property on the object +indicated by PrimaryConnection.

@@ -882,10 +1013,12 @@ PrimaryConnectionType readable s 
 Metered  readable   u
-

Indicates whether the connectivity is metered. This is equivalent to the - metered property of the device associated with the primary connection. +

+Indicates whether the connectivity is metered. This is equivalent to the +metered property of the device associated with the primary connection.

-

Returns: NMMetered +

+Returns: NMMetered

@@ -894,9 +1027,10 @@ Metered readable u 
 ActivatingConnection  readable   o
-

The object path of an active connection that is currently being activated - and which is expected to become the new PrimaryConnection when it finishes - activating. +

+The object path of an active connection that is currently being activated +and which is expected to become the new PrimaryConnection when it finishes +activating.

@@ -905,9 +1039,10 @@ ActivatingConnection readable o 
 Startup  readable   b
-

Indicates whether NM is still starting up; this becomes FALSE when NM has - finished attempting to activate every connection that it might be able to - activate at startup. +

+Indicates whether NM is still starting up; this becomes FALSE when NM has +finished attempting to activate every connection that it might be able to +activate at startup.

@@ -916,7 +1051,8 @@ Startup readable b 
 Version  readable   s
-

NetworkManager version. +

+NetworkManager version.

@@ -925,9 +1061,10 @@ Version readable s 
 Capabilities  readable   au
-

The current set of capabilities. See NMCapability for currently - defined capability numbers. The array is guaranteed to - be sorted in ascending order without duplicates. +

+The current set of capabilities. See NMCapability for currently +defined capability numbers. The array is guaranteed to +be sorted in ascending order without duplicates.

@@ -936,18 +1073,22 @@ Capabilities readable au 
 State  readable   u
-

The overall state of the NetworkManager daemon. +

+The overall state of the NetworkManager daemon.

-

This takes state of all active connections and the connectivity state into account - to produce a single indicator of the network accessibility status. +

+This takes state of all active connections and the connectivity state into account +to produce a single indicator of the network accessibility status.

-

The graphical shells may use this property to provide network connection status - indication and applications may use this to check if Internet connection is - accessible. Shell that is able to cope with captive portals should use the - "Connectivity" property to decide whether to present a captive portal authentication - dialog. +

+The graphical shells may use this property to provide network connection status +indication and applications may use this to check if Internet connection is +accessible. Shell that is able to cope with captive portals should use the +"Connectivity" property to decide whether to present a captive portal authentication +dialog.

-

Returns: NMState +

+Returns: NMState

@@ -956,21 +1097,25 @@ State readable u 
 Connectivity  readable   u
-

The result of the last connectivity check. The connectivity check is triggered - automatically when a default connection becomes available, periodically and by - calling a CheckConnectivity() method. +

+The result of the last connectivity check. The connectivity check is triggered +automatically when a default connection becomes available, periodically and by +calling a CheckConnectivity() method.

-

This property is in general useful for the graphical shell to determine whether - the Internet access is being hijacked by an authentication gateway (a "captive - portal"). In such case it would typically present a web browser window to give - the user a chance to authenticate and call CheckConnectivity() when the user - submits a form or dismisses the window. +

+This property is in general useful for the graphical shell to determine whether +the Internet access is being hijacked by an authentication gateway (a "captive +portal"). In such case it would typically present a web browser window to give +the user a chance to authenticate and call CheckConnectivity() when the user +submits a form or dismisses the window.

-

To determine the whether the user is able to access the Internet without dealing - with captive portals (e.g. to provide a network connection indicator or disable - controls that require Internet access), the "State" property is more suitable. +

+To determine the whether the user is able to access the Internet without dealing +with captive portals (e.g. to provide a network connection indicator or disable +controls that require Internet access), the "State" property is more suitable.

-

Returns: NMConnectivityState +

+Returns: NMConnectivityState

@@ -979,13 +1124,15 @@ Connectivity readable u 
 ConnectivityCheckAvailable  readable   b
-

Indicates whether connectivity checking service has been - configured. This may return true even if the service is not - currently enabled. +

+Indicates whether connectivity checking service has been +configured. This may return true even if the service is not +currently enabled.

-

This is primarily intended for use in a privacy control panel, - as a way to determine whether to show an option to - enable/disable the feature. +

+This is primarily intended for use in a privacy control panel, +as a way to determine whether to show an option to +enable/disable the feature.

@@ -994,9 +1141,10 @@ ConnectivityCheckAvailable readable b 
 ConnectivityCheckEnabled  readwrite  b
-

Indicates whether connectivity checking is enabled. This - property can also be written to disable connectivity - checking (as a privacy control panel might want to do). +

+Indicates whether connectivity checking is enabled. This +property can also be written to disable connectivity +checking (as a privacy control panel might want to do).

@@ -1005,7 +1153,8 @@ ConnectivityCheckEnabled readwrite b 
 ConnectivityCheckUri  readable   s
-

The URI that NetworkManager will hit to check if there is internet connectivity. +

+The URI that NetworkManager will hit to check if there is internet connectivity.

@@ -1014,19 +1163,20 @@ ConnectivityCheckUri readable s 
 GlobalDnsConfiguration  readwrite  a{sv}
-

Dictionary of global DNS settings where the key is one of "searches", - "options" and "domains". The values for the "searches" and "options" keys - are string arrays describing the list of search domains and resolver - options, respectively. The value of the "domains" key is a second-level - dictionary, where each key is a domain name, and each key's value is a - third-level dictionary with the keys "servers" and "options". "servers" is - a string array of DNS servers, "options" is a string array of - domain-specific options. +

+Dictionary of global DNS settings where the key is one of "searches", +"options" and "domains". The values for the "searches" and "options" keys +are string arrays describing the list of search domains and resolver +options, respectively. The value of the "domains" key is a second-level +dictionary, where each key is a domain name, and each key's value is a +third-level dictionary with the keys "servers" and "options". "servers" is +a string array of DNS servers, "options" is a string array of +domain-specific options.

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/index.html b/docs/api/html/index.html index 538c2ac6..81e05e56 100644 --- a/docs/api/html/index.html +++ b/docs/api/html/index.html @@ -7,7 +7,7 @@ - + @@ -16,7 +16,7 @@

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

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/ix01.html b/docs/api/html/ix01.html index ad5a5705..6bc77760 100644 --- a/docs/api/html/ix01.html +++ b/docs/api/html/ix01.html @@ -8,7 +8,7 @@ - + @@ -1658,6 +1658,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/license.html b/docs/api/html/license.html index 45ca298c..e1b68486 100644 --- a/docs/api/html/license.html +++ b/docs/api/html/license.html @@ -7,7 +7,7 @@ - + @@ -55,6 +55,6 @@

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/manpages.html b/docs/api/html/manpages.html index 9250556f..4ce24258 100644 --- a/docs/api/html/manpages.html +++ b/docs/api/html/manpages.html @@ -8,7 +8,7 @@ - + @@ -74,6 +74,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/nm-cloud-setup.html b/docs/api/html/nm-cloud-setup.html index 4691599d..360519fa 100644 --- a/docs/api/html/nm-cloud-setup.html +++ b/docs/api/html/nm-cloud-setup.html @@ -8,7 +8,7 @@ - + @@ -335,6 +335,6 @@ ln -s /etc/systemd/system/timers.target.wants/nm-cloud-setup.timer /usr/lib/syst
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/nm-dbus-types.html b/docs/api/html/nm-dbus-types.html index e6c54f9c..4c90a748 100644 --- a/docs/api/html/nm-dbus-types.html +++ b/docs/api/html/nm-dbus-types.html @@ -8,7 +8,7 @@ - + @@ -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.

@@ -5321,6 +5321,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/nm-initrd-generator.html b/docs/api/html/nm-initrd-generator.html index 214cfd67..8962d9c1 100644 --- a/docs/api/html/nm-initrd-generator.html +++ b/docs/api/html/nm-initrd-generator.html @@ -8,7 +8,7 @@ - + @@ -170,6 +170,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/nm-online.html b/docs/api/html/nm-online.html index 148c1821..53c2cc52 100644 --- a/docs/api/html/nm-online.html +++ b/docs/api/html/nm-online.html @@ -8,7 +8,7 @@ - + @@ -135,6 +135,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/nm-openvswitch.html b/docs/api/html/nm-openvswitch.html index 0d2d156a..740989ad 100644 --- a/docs/api/html/nm-openvswitch.html +++ b/docs/api/html/nm-openvswitch.html @@ -8,7 +8,7 @@ - + @@ -172,6 +172,6 @@ Connection 'ovs-slave-eth3' (8dedeecb-ed12-482b-b77a-24a4fb835136) successfully
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/nm-settings-dbus.html b/docs/api/html/nm-settings-dbus.html index 31306709..d8c9631a 100644 --- a/docs/api/html/nm-settings-dbus.html +++ b/docs/api/html/nm-settings-dbus.html @@ -8,7 +8,7 @@ - + @@ -4278,6 +4278,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/nm-settings-ifcfg-rh.html b/docs/api/html/nm-settings-ifcfg-rh.html index 698aa4e1..390509ad 100644 --- a/docs/api/html/nm-settings-ifcfg-rh.html +++ b/docs/api/html/nm-settings-ifcfg-rh.html @@ -8,7 +8,7 @@ - + @@ -2789,6 +2789,6 @@ Allowed values: "yes", "no"
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/nm-settings-keyfile.html b/docs/api/html/nm-settings-keyfile.html index e8bf490f..69bb333c 100644 --- a/docs/api/html/nm-settings-keyfile.html +++ b/docs/api/html/nm-settings-keyfile.html @@ -8,7 +8,7 @@ - + @@ -567,6 +567,6 @@ Example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/nm-settings-nmcli.html b/docs/api/html/nm-settings-nmcli.html index 3cd7e721..e54b049c 100644 --- a/docs/api/html/nm-settings-nmcli.html +++ b/docs/api/html/nm-settings-nmcli.html @@ -8,7 +8,7 @@ - + @@ -5286,6 +5286,6 @@ The actual string to print.
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/nm-vpn-dbus-types.html b/docs/api/html/nm-vpn-dbus-types.html index 7673b32e..31c1d323 100644 --- a/docs/api/html/nm-vpn-dbus-types.html +++ b/docs/api/html/nm-vpn-dbus-types.html @@ -8,7 +8,7 @@ - + @@ -555,6 +555,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/nmcli-examples.html b/docs/api/html/nmcli-examples.html index 075c0d3c..2bc6cbc2 100644 --- a/docs/api/html/nmcli-examples.html +++ b/docs/api/html/nmcli-examples.html @@ -8,7 +8,7 @@ - + @@ -649,6 +649,6 @@ Connection 'ethernet-4' (de89cdeb-a3e1-4d53-8fa0-c22546c775f4) successfully
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/nmcli.html b/docs/api/html/nmcli.html index ab08d70d..5ca8f1f4 100644 --- a/docs/api/html/nmcli.html +++ b/docs/api/html/nmcli.html @@ -8,7 +8,7 @@ - + @@ -1832,6 +1832,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/nmtui.html b/docs/api/html/nmtui.html index edf90abf..ee9ab9f0 100644 --- a/docs/api/html/nmtui.html +++ b/docs/api/html/nmtui.html @@ -8,7 +8,7 @@ - + @@ -83,6 +83,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/ref-dbus-access-points.html b/docs/api/html/ref-dbus-access-points.html index 38314ff1..4ad00ffb 100644 --- a/docs/api/html/ref-dbus-access-points.html +++ b/docs/api/html/ref-dbus-access-points.html @@ -8,7 +8,7 @@ - + @@ -27,6 +27,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/ref-dbus-active-connections.html b/docs/api/html/ref-dbus-active-connections.html index 3c784f47..5bb979a8 100644 --- a/docs/api/html/ref-dbus-active-connections.html +++ b/docs/api/html/ref-dbus-active-connections.html @@ -8,7 +8,7 @@ - + @@ -32,6 +32,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/ref-dbus-agent-manager.html b/docs/api/html/ref-dbus-agent-manager.html index e0118f11..1c5c6f6d 100644 --- a/docs/api/html/ref-dbus-agent-manager.html +++ b/docs/api/html/ref-dbus-agent-manager.html @@ -8,7 +8,7 @@ - + @@ -27,6 +27,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/ref-dbus-checkpoint.html b/docs/api/html/ref-dbus-checkpoint.html index 59bc9d83..5242311c 100644 --- a/docs/api/html/ref-dbus-checkpoint.html +++ b/docs/api/html/ref-dbus-checkpoint.html @@ -8,7 +8,7 @@ - + @@ -27,6 +27,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/ref-dbus-devices.html b/docs/api/html/ref-dbus-devices.html index 58b079c2..7d732909 100644 --- a/docs/api/html/ref-dbus-devices.html +++ b/docs/api/html/ref-dbus-devices.html @@ -8,7 +8,7 @@ - + @@ -119,6 +119,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/ref-dbus-dhcp4-configs.html b/docs/api/html/ref-dbus-dhcp4-configs.html index 3a66b47e..ca0f9a8d 100644 --- a/docs/api/html/ref-dbus-dhcp4-configs.html +++ b/docs/api/html/ref-dbus-dhcp4-configs.html @@ -8,7 +8,7 @@ - + @@ -27,6 +27,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/ref-dbus-dhcp6-configs.html b/docs/api/html/ref-dbus-dhcp6-configs.html index 3a874eb9..dd747c61 100644 --- a/docs/api/html/ref-dbus-dhcp6-configs.html +++ b/docs/api/html/ref-dbus-dhcp6-configs.html @@ -8,7 +8,7 @@ - + @@ -27,6 +27,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/ref-dbus-dns-manager.html b/docs/api/html/ref-dbus-dns-manager.html index 67bfefb8..d33bc1dc 100644 --- a/docs/api/html/ref-dbus-dns-manager.html +++ b/docs/api/html/ref-dbus-dns-manager.html @@ -8,7 +8,7 @@ - + @@ -27,6 +27,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/ref-dbus-ip4-configs.html b/docs/api/html/ref-dbus-ip4-configs.html index 832e29fc..a45f8ff3 100644 --- a/docs/api/html/ref-dbus-ip4-configs.html +++ b/docs/api/html/ref-dbus-ip4-configs.html @@ -8,7 +8,7 @@ - + @@ -27,6 +27,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/ref-dbus-ip6-configs.html b/docs/api/html/ref-dbus-ip6-configs.html index 9b538510..e9c50240 100644 --- a/docs/api/html/ref-dbus-ip6-configs.html +++ b/docs/api/html/ref-dbus-ip6-configs.html @@ -8,7 +8,7 @@ - + @@ -27,6 +27,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/ref-dbus-manager.html b/docs/api/html/ref-dbus-manager.html index 70ab0b89..4b2230fd 100644 --- a/docs/api/html/ref-dbus-manager.html +++ b/docs/api/html/ref-dbus-manager.html @@ -8,7 +8,7 @@ - + @@ -27,6 +27,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/ref-dbus-settings-manager.html b/docs/api/html/ref-dbus-settings-manager.html index 5640413a..e4b8fb89 100644 --- a/docs/api/html/ref-dbus-settings-manager.html +++ b/docs/api/html/ref-dbus-settings-manager.html @@ -8,7 +8,7 @@ - + @@ -27,6 +27,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/ref-dbus-settings.html b/docs/api/html/ref-dbus-settings.html index 56d7fb20..2da4ae49 100644 --- a/docs/api/html/ref-dbus-settings.html +++ b/docs/api/html/ref-dbus-settings.html @@ -8,7 +8,7 @@ - + @@ -27,6 +27,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/ref-dbus-wifi-p2p-peers.html b/docs/api/html/ref-dbus-wifi-p2p-peers.html index ecd96159..bca9f9b8 100644 --- a/docs/api/html/ref-dbus-wifi-p2p-peers.html +++ b/docs/api/html/ref-dbus-wifi-p2p-peers.html @@ -8,7 +8,7 @@ - + @@ -27,6 +27,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/ref-settings.html b/docs/api/html/ref-settings.html index b2bacf2e..5e7e464d 100644 --- a/docs/api/html/ref-settings.html +++ b/docs/api/html/ref-settings.html @@ -8,7 +8,7 @@ - + @@ -196,6 +196,6 @@

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/secret-agents.html b/docs/api/html/secret-agents.html index 63aacf05..fa1d052f 100644 --- a/docs/api/html/secret-agents.html +++ b/docs/api/html/secret-agents.html @@ -8,7 +8,7 @@ - + @@ -33,6 +33,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/secrets-flags.html b/docs/api/html/secrets-flags.html index 1d59a930..66c07cef 100644 --- a/docs/api/html/secrets-flags.html +++ b/docs/api/html/secrets-flags.html @@ -8,7 +8,7 @@ - + @@ -58,6 +58,6 @@

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-6lowpan.html b/docs/api/html/settings-6lowpan.html index 7daf602d..fd163b30 100644 --- a/docs/api/html/settings-6lowpan.html +++ b/docs/api/html/settings-6lowpan.html @@ -8,7 +8,7 @@ - + @@ -64,6 +64,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-802-11-olpc-mesh.html b/docs/api/html/settings-802-11-olpc-mesh.html index 1dd33145..b5370389 100644 --- a/docs/api/html/settings-802-11-olpc-mesh.html +++ b/docs/api/html/settings-802-11-olpc-mesh.html @@ -8,7 +8,7 @@ - + @@ -78,6 +78,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-802-11-wireless-security.html b/docs/api/html/settings-802-11-wireless-security.html index 033d365e..d2926389 100644 --- a/docs/api/html/settings-802-11-wireless-security.html +++ b/docs/api/html/settings-802-11-wireless-security.html @@ -8,7 +8,7 @@ - + @@ -180,6 +180,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-802-11-wireless.html b/docs/api/html/settings-802-11-wireless.html index ecdbfab9..68d7e07c 100644 --- a/docs/api/html/settings-802-11-wireless.html +++ b/docs/api/html/settings-802-11-wireless.html @@ -8,7 +8,7 @@ - + @@ -180,6 +180,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-802-1x.html b/docs/api/html/settings-802-1x.html index a1f6f6cf..91015533 100644 --- a/docs/api/html/settings-802-1x.html +++ b/docs/api/html/settings-802-1x.html @@ -8,7 +8,7 @@ - + @@ -342,6 +342,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-802-3-ethernet.html b/docs/api/html/settings-802-3-ethernet.html index 3b38ba11..b743783e 100644 --- a/docs/api/html/settings-802-3-ethernet.html +++ b/docs/api/html/settings-802-3-ethernet.html @@ -8,7 +8,7 @@ - + @@ -156,6 +156,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-adsl.html b/docs/api/html/settings-adsl.html index baa6ce9c..10cdb8d2 100644 --- a/docs/api/html/settings-adsl.html +++ b/docs/api/html/settings-adsl.html @@ -8,7 +8,7 @@ - + @@ -102,6 +102,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-bluetooth.html b/docs/api/html/settings-bluetooth.html index 76216b18..91bdf443 100644 --- a/docs/api/html/settings-bluetooth.html +++ b/docs/api/html/settings-bluetooth.html @@ -8,7 +8,7 @@ - + @@ -72,6 +72,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-bond-port.html b/docs/api/html/settings-bond-port.html index 4516d8c5..6496b891 100644 --- a/docs/api/html/settings-bond-port.html +++ b/docs/api/html/settings-bond-port.html @@ -8,7 +8,7 @@ - + @@ -64,6 +64,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-bond.html b/docs/api/html/settings-bond.html index 77da2c93..30fc8781 100644 --- a/docs/api/html/settings-bond.html +++ b/docs/api/html/settings-bond.html @@ -8,7 +8,7 @@ - + @@ -72,6 +72,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-bridge-port.html b/docs/api/html/settings-bridge-port.html index 5c2aa4f7..7b72a526 100644 --- a/docs/api/html/settings-bridge-port.html +++ b/docs/api/html/settings-bridge-port.html @@ -8,7 +8,7 @@ - + @@ -84,6 +84,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-bridge.html b/docs/api/html/settings-bridge.html index b19b3f0f..244f728a 100644 --- a/docs/api/html/settings-bridge.html +++ b/docs/api/html/settings-bridge.html @@ -8,7 +8,7 @@ - + @@ -228,6 +228,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-cdma.html b/docs/api/html/settings-cdma.html index fb29acc4..054dee32 100644 --- a/docs/api/html/settings-cdma.html +++ b/docs/api/html/settings-cdma.html @@ -8,7 +8,7 @@ - + @@ -90,6 +90,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-connection.html b/docs/api/html/settings-connection.html index e9ffb05b..f8e3c6c3 100644 --- a/docs/api/html/settings-connection.html +++ b/docs/api/html/settings-connection.html @@ -8,7 +8,7 @@ - + @@ -216,6 +216,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-dcb.html b/docs/api/html/settings-dcb.html index 784cff03..b4df6ea6 100644 --- a/docs/api/html/settings-dcb.html +++ b/docs/api/html/settings-dcb.html @@ -8,7 +8,7 @@ - + @@ -150,6 +150,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-dummy.html b/docs/api/html/settings-dummy.html index d5c7d25c..027121fe 100644 --- a/docs/api/html/settings-dummy.html +++ b/docs/api/html/settings-dummy.html @@ -8,7 +8,7 @@ - + @@ -59,6 +59,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-ethtool.html b/docs/api/html/settings-ethtool.html index 011f8cb5..42717eb2 100644 --- a/docs/api/html/settings-ethtool.html +++ b/docs/api/html/settings-ethtool.html @@ -8,7 +8,7 @@ - + @@ -59,6 +59,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-generic.html b/docs/api/html/settings-generic.html index 2e03accd..c6a5a552 100644 --- a/docs/api/html/settings-generic.html +++ b/docs/api/html/settings-generic.html @@ -8,7 +8,7 @@ - + @@ -59,6 +59,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-gsm.html b/docs/api/html/settings-gsm.html index a0c4cca8..682118ee 100644 --- a/docs/api/html/settings-gsm.html +++ b/docs/api/html/settings-gsm.html @@ -8,7 +8,7 @@ - + @@ -144,6 +144,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-hostname.html b/docs/api/html/settings-hostname.html index f93dd8f9..52e0d5fe 100644 --- a/docs/api/html/settings-hostname.html +++ b/docs/api/html/settings-hostname.html @@ -8,7 +8,7 @@ - + @@ -84,6 +84,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-infiniband.html b/docs/api/html/settings-infiniband.html index b14cc1c7..2d7ffa9a 100644 --- a/docs/api/html/settings-infiniband.html +++ b/docs/api/html/settings-infiniband.html @@ -8,7 +8,7 @@ - + @@ -90,6 +90,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-ip-tunnel.html b/docs/api/html/settings-ip-tunnel.html index 4a154d49..859675bc 100644 --- a/docs/api/html/settings-ip-tunnel.html +++ b/docs/api/html/settings-ip-tunnel.html @@ -8,7 +8,7 @@ - + @@ -138,6 +138,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-ipv4.html b/docs/api/html/settings-ipv4.html index 20cd3236..f4a9c416 100644 --- a/docs/api/html/settings-ipv4.html +++ b/docs/api/html/settings-ipv4.html @@ -8,7 +8,7 @@ - + @@ -222,6 +222,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-ipv6.html b/docs/api/html/settings-ipv6.html index af20a399..e0965661 100644 --- a/docs/api/html/settings-ipv6.html +++ b/docs/api/html/settings-ipv6.html @@ -8,7 +8,7 @@ - + @@ -234,6 +234,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-macsec.html b/docs/api/html/settings-macsec.html index de743ee4..27228aa6 100644 --- a/docs/api/html/settings-macsec.html +++ b/docs/api/html/settings-macsec.html @@ -8,7 +8,7 @@ - + @@ -114,6 +114,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-macvlan.html b/docs/api/html/settings-macvlan.html index b09ca148..554d61d5 100644 --- a/docs/api/html/settings-macvlan.html +++ b/docs/api/html/settings-macvlan.html @@ -8,7 +8,7 @@ - + @@ -84,6 +84,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-match.html b/docs/api/html/settings-match.html index 172d0694..20a077fc 100644 --- a/docs/api/html/settings-match.html +++ b/docs/api/html/settings-match.html @@ -8,7 +8,7 @@ - + @@ -84,6 +84,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-ovs-bridge.html b/docs/api/html/settings-ovs-bridge.html index 011e49bc..9754e4bf 100644 --- a/docs/api/html/settings-ovs-bridge.html +++ b/docs/api/html/settings-ovs-bridge.html @@ -8,7 +8,7 @@ - + @@ -90,6 +90,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-ovs-dpdk.html b/docs/api/html/settings-ovs-dpdk.html index 40b560ae..74445249 100644 --- a/docs/api/html/settings-ovs-dpdk.html +++ b/docs/api/html/settings-ovs-dpdk.html @@ -8,7 +8,7 @@ - + @@ -72,6 +72,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-ovs-external-ids.html b/docs/api/html/settings-ovs-external-ids.html index 1a196728..d3f0657f 100644 --- a/docs/api/html/settings-ovs-external-ids.html +++ b/docs/api/html/settings-ovs-external-ids.html @@ -8,7 +8,7 @@ - + @@ -64,6 +64,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-ovs-interface.html b/docs/api/html/settings-ovs-interface.html index 931527db..41f2c8a3 100644 --- a/docs/api/html/settings-ovs-interface.html +++ b/docs/api/html/settings-ovs-interface.html @@ -8,7 +8,7 @@ - + @@ -64,6 +64,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-ovs-patch.html b/docs/api/html/settings-ovs-patch.html index c916043d..2b755089 100644 --- a/docs/api/html/settings-ovs-patch.html +++ b/docs/api/html/settings-ovs-patch.html @@ -8,7 +8,7 @@ - + @@ -64,6 +64,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-ovs-port.html b/docs/api/html/settings-ovs-port.html index 2aa91ff7..6ca34831 100644 --- a/docs/api/html/settings-ovs-port.html +++ b/docs/api/html/settings-ovs-port.html @@ -8,7 +8,7 @@ - + @@ -96,6 +96,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-ppp.html b/docs/api/html/settings-ppp.html index 493cf752..fea6add6 100644 --- a/docs/api/html/settings-ppp.html +++ b/docs/api/html/settings-ppp.html @@ -8,7 +8,7 @@ - + @@ -168,6 +168,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-pppoe.html b/docs/api/html/settings-pppoe.html index 277dde3d..f91ed115 100644 --- a/docs/api/html/settings-pppoe.html +++ b/docs/api/html/settings-pppoe.html @@ -8,7 +8,7 @@ - + @@ -90,6 +90,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-proxy.html b/docs/api/html/settings-proxy.html index 1b22192b..3f5a6248 100644 --- a/docs/api/html/settings-proxy.html +++ b/docs/api/html/settings-proxy.html @@ -8,7 +8,7 @@ - + @@ -84,6 +84,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-serial.html b/docs/api/html/settings-serial.html index ff473d40..20ddfb5b 100644 --- a/docs/api/html/settings-serial.html +++ b/docs/api/html/settings-serial.html @@ -8,7 +8,7 @@ - + @@ -90,6 +90,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-sriov.html b/docs/api/html/settings-sriov.html index 9f7fded6..a9daf616 100644 --- a/docs/api/html/settings-sriov.html +++ b/docs/api/html/settings-sriov.html @@ -8,7 +8,7 @@ - + @@ -78,6 +78,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-tc.html b/docs/api/html/settings-tc.html index ebcf0f23..9f4d53ee 100644 --- a/docs/api/html/settings-tc.html +++ b/docs/api/html/settings-tc.html @@ -8,7 +8,7 @@ - + @@ -72,6 +72,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-team-port.html b/docs/api/html/settings-team-port.html index 7fe18f0a..dbbe038d 100644 --- a/docs/api/html/settings-team-port.html +++ b/docs/api/html/settings-team-port.html @@ -8,7 +8,7 @@ - + @@ -102,6 +102,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-team.html b/docs/api/html/settings-team.html index 99cd91ee..412c7380 100644 --- a/docs/api/html/settings-team.html +++ b/docs/api/html/settings-team.html @@ -8,7 +8,7 @@ - + @@ -162,6 +162,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-tun.html b/docs/api/html/settings-tun.html index 46e23d62..f860607c 100644 --- a/docs/api/html/settings-tun.html +++ b/docs/api/html/settings-tun.html @@ -8,7 +8,7 @@ - + @@ -96,6 +96,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-user.html b/docs/api/html/settings-user.html index 33e64f03..1c8e4626 100644 --- a/docs/api/html/settings-user.html +++ b/docs/api/html/settings-user.html @@ -8,7 +8,7 @@ - + @@ -64,6 +64,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-veth.html b/docs/api/html/settings-veth.html index d53121c9..ea702cc6 100644 --- a/docs/api/html/settings-veth.html +++ b/docs/api/html/settings-veth.html @@ -8,7 +8,7 @@ - + @@ -64,6 +64,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-vlan.html b/docs/api/html/settings-vlan.html index be1e1d1f..ef3df77d 100644 --- a/docs/api/html/settings-vlan.html +++ b/docs/api/html/settings-vlan.html @@ -8,7 +8,7 @@ - + @@ -96,6 +96,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-vpn.html b/docs/api/html/settings-vpn.html index afd1ac72..9f8d5473 100644 --- a/docs/api/html/settings-vpn.html +++ b/docs/api/html/settings-vpn.html @@ -8,7 +8,7 @@ - + @@ -96,6 +96,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-vrf.html b/docs/api/html/settings-vrf.html index 6c49c512..12ba3b34 100644 --- a/docs/api/html/settings-vrf.html +++ b/docs/api/html/settings-vrf.html @@ -8,7 +8,7 @@ - + @@ -64,6 +64,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-vxlan.html b/docs/api/html/settings-vxlan.html index a0ec0963..b497855d 100644 --- a/docs/api/html/settings-vxlan.html +++ b/docs/api/html/settings-vxlan.html @@ -8,7 +8,7 @@ - + @@ -156,6 +156,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-wifi-p2p.html b/docs/api/html/settings-wifi-p2p.html index 9fe0a90b..8328b1d8 100644 --- a/docs/api/html/settings-wifi-p2p.html +++ b/docs/api/html/settings-wifi-p2p.html @@ -8,7 +8,7 @@ - + @@ -78,6 +78,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-wimax.html b/docs/api/html/settings-wimax.html index d733d7fd..919bfe4e 100644 --- a/docs/api/html/settings-wimax.html +++ b/docs/api/html/settings-wimax.html @@ -8,7 +8,7 @@ - + @@ -72,6 +72,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-wireguard.html b/docs/api/html/settings-wireguard.html index 01157792..850c85ab 100644 --- a/docs/api/html/settings-wireguard.html +++ b/docs/api/html/settings-wireguard.html @@ -8,7 +8,7 @@ - + @@ -114,6 +114,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/settings-wpan.html b/docs/api/html/settings-wpan.html index b0e3b24b..474d1155 100644 --- a/docs/api/html/settings-wpan.html +++ b/docs/api/html/settings-wpan.html @@ -8,7 +8,7 @@ - + @@ -90,6 +90,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/spec.html b/docs/api/html/spec.html index fcaf67d5..8de008d9 100644 --- a/docs/api/html/spec.html +++ b/docs/api/html/spec.html @@ -8,7 +8,7 @@ - + @@ -190,6 +190,6 @@

-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/html/style.css b/docs/api/html/style.css index c163abaa..2eeda1f0 100644 --- a/docs/api/html/style.css +++ b/docs/api/html/style.css @@ -461,22 +461,22 @@ span.linenos { color: inherit; background-color: transparent; padding-left: 5px; td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } .hll { background-color: #ffffcc } -.c { color: #408080; font-style: italic } /* Comment */ +.c { color: #3D7B7B; font-style: italic } /* Comment */ .err { border: 1px solid #FF0000 } /* Error */ .k { color: #008000; font-weight: bold } /* Keyword */ .o { color: #666666 } /* Operator */ -.ch { color: #408080; font-style: italic } /* Comment.Hashbang */ -.cm { color: #408080; font-style: italic } /* Comment.Multiline */ -.cp { color: #BC7A00 } /* Comment.Preproc */ -.cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */ -.c1 { color: #408080; font-style: italic } /* Comment.Single */ -.cs { color: #408080; font-style: italic } /* Comment.Special */ +.ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ +.cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ +.cp { color: #9C6500 } /* Comment.Preproc */ +.cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ +.c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ +.cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ .gd { color: #A00000 } /* Generic.Deleted */ .ge { font-style: italic } /* Generic.Emph */ -.gr { color: #FF0000 } /* Generic.Error */ +.gr { color: #E40000 } /* Generic.Error */ .gh { color: #000080; font-weight: bold } /* Generic.Heading */ -.gi { color: #00A000 } /* Generic.Inserted */ -.go { color: #888888 } /* Generic.Output */ +.gi { color: #008400 } /* Generic.Inserted */ +.go { color: #717171 } /* Generic.Output */ .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ .gs { font-weight: bold } /* Generic.Strong */ .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ @@ -489,15 +489,15 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: .kt { color: #B00040 } /* Keyword.Type */ .m { color: #666666 } /* Literal.Number */ .s { color: #BA2121 } /* Literal.String */ -.na { color: #7D9029 } /* Name.Attribute */ +.na { color: #687822 } /* Name.Attribute */ .nb { color: #008000 } /* Name.Builtin */ .nc { color: #0000FF; font-weight: bold } /* Name.Class */ .no { color: #880000 } /* Name.Constant */ .nd { color: #AA22FF } /* Name.Decorator */ -.ni { color: #999999; font-weight: bold } /* Name.Entity */ -.ne { color: #D2413A; font-weight: bold } /* Name.Exception */ +.ni { color: #717171; font-weight: bold } /* Name.Entity */ +.ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ .nf { color: #0000FF } /* Name.Function */ -.nl { color: #A0A000 } /* Name.Label */ +.nl { color: #767600 } /* Name.Label */ .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ .nt { color: #008000; font-weight: bold } /* Name.Tag */ .nv { color: #19177C } /* Name.Variable */ @@ -514,11 +514,11 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: .dl { color: #BA2121 } /* Literal.String.Delimiter */ .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ .s2 { color: #BA2121 } /* Literal.String.Double */ -.se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */ +.se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ .sh { color: #BA2121 } /* Literal.String.Heredoc */ -.si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */ +.si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ .sx { color: #008000 } /* Literal.String.Other */ -.sr { color: #BB6688 } /* Literal.String.Regex */ +.sr { color: #A45A77 } /* Literal.String.Regex */ .s1 { color: #BA2121 } /* Literal.String.Single */ .ss { color: #19177C } /* Literal.String.Symbol */ .bp { color: #008000 } /* Name.Builtin.Pseudo */ diff --git a/docs/api/html/vpn-plugins.html b/docs/api/html/vpn-plugins.html index 49dd5c89..9989a5bf 100644 --- a/docs/api/html/vpn-plugins.html +++ b/docs/api/html/vpn-plugins.html @@ -8,7 +8,7 @@ - + @@ -37,6 +37,6 @@
-
Generated by GTK-Doc V1.33.0
+
Generated by GTK-Doc V1.33.1 \ No newline at end of file diff --git a/docs/api/version.xml b/docs/api/version.xml index c85090d6..c097b6a0 100644 --- a/docs/api/version.xml +++ b/docs/api/version.xml @@ -1 +1 @@ -1.38.2 +1.38.4 -- cgit 1.3.0-6-gf8a5 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/Makefile.in | 18 +- 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 +- docs/api/settings-spec.xml | 106 +- docs/api/version.xml | 2 +- 72 files changed, 2725 insertions(+), 1749 deletions(-) (limited to 'docs/api') diff --git a/docs/api/Makefile.in b/docs/api/Makefile.in index b24b8b6b..dfa37d09 100644 --- a/docs/api/Makefile.in +++ b/docs/api/Makefile.in @@ -124,8 +124,8 @@ am__aclocal_m4_deps = $(top_srcdir)/m4/attributes.m4 \ $(top_srcdir)/m4/compiler_options.m4 \ $(top_srcdir)/m4/gettext.m4 $(top_srcdir)/m4/git-sha-record.m4 \ $(top_srcdir)/m4/gnome-code-coverage.m4 \ - $(top_srcdir)/m4/gtk-doc.m4 $(top_srcdir)/m4/iconv.m4 \ - $(top_srcdir)/m4/intlmacosx.m4 $(top_srcdir)/m4/intltool.m4 \ + $(top_srcdir)/m4/gtk-doc.m4 $(top_srcdir)/m4/host-cpu-c-abi.m4 \ + $(top_srcdir)/m4/iconv.m4 $(top_srcdir)/m4/intlmacosx.m4 \ $(top_srcdir)/m4/introspection.m4 $(top_srcdir)/m4/lib-ld.m4 \ $(top_srcdir)/m4/lib-link.m4 $(top_srcdir)/m4/lib-prefix.m4 \ $(top_srcdir)/m4/libtool.m4 $(top_srcdir)/m4/ltoptions.m4 \ @@ -164,7 +164,6 @@ am__DIST_COMMON = $(srcdir)/Makefile.in $(srcdir)/version.xml.in \ $(top_srcdir)/gtk-doc.make DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) ACLOCAL = @ACLOCAL@ -ALL_LINGUAS = @ALL_LINGUAS@ AMTAR = @AMTAR@ AM_CFLAGS = @AM_CFLAGS@ AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ @@ -198,7 +197,6 @@ DISTRO_NETWORK_SERVICE = @DISTRO_NETWORK_SERVICE@ DLLTOOL = @DLLTOOL@ DL_LIBS = @DL_LIBS@ DNSMASQ_PATH = @DNSMASQ_PATH@ -DNSSEC_TRIGGER_PATH = @DNSSEC_TRIGGER_PATH@ DSYMUTIL = @DSYMUTIL@ DUMPBIN = @DUMPBIN@ ECHO_C = @ECHO_C@ @@ -236,14 +234,6 @@ INSTALL_PROGRAM = @INSTALL_PROGRAM@ INSTALL_SCRIPT = @INSTALL_SCRIPT@ INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ INTLLIBS = @INTLLIBS@ -INTLTOOL_EXTRACT = @INTLTOOL_EXTRACT@ -INTLTOOL_MERGE = @INTLTOOL_MERGE@ -INTLTOOL_PERL = @INTLTOOL_PERL@ -INTLTOOL_UPDATE = @INTLTOOL_UPDATE@ -INTLTOOL_V_MERGE = @INTLTOOL_V_MERGE@ -INTLTOOL_V_MERGE_OPTIONS = @INTLTOOL_V_MERGE_OPTIONS@ -INTLTOOL__v_MERGE_ = @INTLTOOL__v_MERGE_@ -INTLTOOL__v_MERGE_0 = @INTLTOOL__v_MERGE_0@ INTL_MACOSX_LIBS = @INTL_MACOSX_LIBS@ INTROSPECTION_CFLAGS = @INTROSPECTION_CFLAGS@ INTROSPECTION_COMPILER = @INTROSPECTION_COMPILER@ @@ -297,8 +287,8 @@ MOBILE_BROADBAND_PROVIDER_INFO_CFLAGS = @MOBILE_BROADBAND_PROVIDER_INFO_CFLAGS@ MOBILE_BROADBAND_PROVIDER_INFO_LIBS = @MOBILE_BROADBAND_PROVIDER_INFO_LIBS@ MOC = @MOC@ MSGFMT = @MSGFMT@ -MSGFMT_015 = @MSGFMT_015@ MSGMERGE = @MSGMERGE@ +MSGMERGE_FOR_MSGFMT_OPTION = @MSGMERGE_FOR_MSGFMT_OPTION@ NEWT_CFLAGS = @NEWT_CFLAGS@ NEWT_LIBS = @NEWT_LIBS@ NFT_PATH = @NFT_PATH@ @@ -422,8 +412,6 @@ htmldir = @htmldir@ includedir = @includedir@ infodir = @infodir@ install_sh = @install_sh@ -intltool__v_merge_options_ = @intltool__v_merge_options_@ -intltool__v_merge_options_0 = @intltool__v_merge_options_0@ libdir = @libdir@ libexecdir = @libexecdir@ localedir = @localedir@ 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.

    -

  • +

  • +

    In general, startup complete is not reached as long as NetworkManager is busy activating a device and as long as there are profiles in activating state. During boot, NetworkManager starts autoactivating @@ -84,7 +85,15 @@ setting). While trying and retrying, NetworkManager is busy until all profiles and devices either reached an activated or disconnected state and no further events are expected. -

    • +

    +

    +

    +

    + Basically, as long as there are devices and connections in activating + state visible with nmcli device and nmcli connection, + startup is still pending. +

    +

  • When a device reaches activated state, depends on its configuration. For example, with a profile with both IPv4 and IPv6 addressing @@ -104,10 +113,24 @@ without ports, NetworkManager-wait-online.service blocks until timeout. This is a configuration error.

    • +

  • + Dispatcher scripts for the "pre-up" event run at a late stage during activation + of a profile. These scripts block the activation for when NetworkManager considers + the profile fully activated. + See also NetworkManager-dispatcher(8) + for details. +

    • +

  • + The connection property connection.wait-activation-delay also + adds an additional delay during activation and delays startup complete. This is to + workaround certain cases where a device is known to not be ready for a certain + amount of time. +

  • The property connection.wait-device-timeout of the connection profiles waits until the waited devices appear. This is useful if the driver - takes a longer time to detect the networking interfaces. + takes a longer time to detect the networking interfaces. Similar with the + connection.gateway-ping-timeout property.

  • With Wi-Fi devices, NetworkManager needs to wait for the first scan diff --git a/docs/api/html/NetworkManager.conf.html b/docs/api/html/NetworkManager.conf.html index 15dfe367..e2bd8c54 100644 --- a/docs/api/html/NetworkManager.conf.html +++ b/docs/api/html/NetworkManager.conf.html @@ -334,17 +334,11 @@ no-auto-default=* manual page for more details).

    systemd-resolved: NetworkManager will push the DNS configuration to systemd-resolved

    -

    unbound: NetworkManager will talk - to unbound and dnssec-triggerd, using "Conditional Forwarding" - with DNSSEC support. /etc/resolv.conf - will be managed by dnssec-trigger daemon. This option is - deprecated. Note that dnssec-trigger ships a NetworkManager dispatcher - script so this DNS plugin is not necessary.

    none: NetworkManager will not modify resolv.conf. This implies rc-manager unmanaged

    -

    Note that the plugins dnsmasq, systemd-resolved - and unbound are caching local nameservers. +

    Note that the plugins dnsmasq and systemd-resolved + are caching local nameservers. Hence, when NetworkManager writes /run/NetworkManager/resolv.conf and /etc/resolv.conf (according to rc-manager setting below), the name server there will be localhost only. @@ -618,6 +612,19 @@ unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth Just enable level=TRACE and domains=ALL to collect everything.

    +

    + The recommended way for enabling logging is with a file /etc/NetworkManager/conf.d/95-logging.conf + that contains +

    +
    +[logging]
+level=TRACE
+domains=ALL
+
    +

    + and restart the daemon with systemctl restart NetworkManager. Then + reproduce the problem. You can find the logs in syslog (for example journalctl). +

    Any settings here are overridden by the --log-level and --log-domains command-line options. @@ -628,12 +635,18 @@ unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth in NetworkManager.conf and restart the service to enable verbose logging early on.

    +

    + By setting nm.debug on the kernel command line (either from + /run/NetworkManager/proc-cmdline or /proc/cmdline), + debug logging is enabled. This overrides both the command-line options and the settings + from NetworkManager.conf. +

    NetworkManager's logging aims not to contain private sensitive data and you should be fine sharing the debug logs. Still, there will be IP addresses and your network setup, if you consider that private - then review the log before sharing. Do not mangle the logfile in - a way that distorts the meaning too much. + then review the log before sharing. However, try not to mangle the logfile + in a way that distorts the meaning too much.

    NetworkManager uses syslog or systemd-journald, depending on configuration. @@ -804,6 +817,10 @@ ipv6.ip6-privacy=0

    If unspecified, the ultimate default values depends on the DNS plugin. With systemd-resolved the default currently is "no" (0) and for all other plugins also "no" (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.

    + +

    connection.dns-over-tls

    If unspecified, the ultimate default values depends on the DNS plugin. With systemd-resolved the default currently is global setting and for all other plugins "no" (0).

    @@ -890,6 +907,10 @@ ipv6.ip6-privacy=0 +

    ipv4.link-local

    +

    If left unspecified, fallback to "auto" which makes it dependent on "ipv4.method" setting.

    + +

    ipv4.route-metric

    @@ -901,6 +922,12 @@ ipv6.ip6-privacy=0

    +

    ipv6.addr-gen-mode

    +

    If the per-profile setting is either "default" or "default-or-eui64", the + global default is used. If the default is unspecified, the fallback value is either "stable-privacy" + or "eui64", depending on whether the per-profile setting is "default" or "default-or-eui64, respectively.

    + +

    ipv6.ra-timeout

    If left unspecified, the default value depends on the sysctl solicitation settings.

    diff --git a/docs/api/html/NetworkManager.devhelp2 b/docs/api/html/NetworkManager.devhelp2 index c83bf67f..7fd00dea 100644 --- a/docs/api/html/NetworkManager.devhelp2 +++ b/docs/api/html/NetworkManager.devhelp2 @@ -514,6 +514,7 @@ + @@ -849,6 +850,14 @@ + + + + + + + + diff --git a/docs/api/html/NetworkManager.html b/docs/api/html/NetworkManager.html index 91e7e085..1ce88b40 100644 --- a/docs/api/html/NetworkManager.html +++ b/docs/api/html/NetworkManager.html @@ -278,6 +278,11 @@ RateLimitBurst options of journald (see journald.conf(5) manual).

    +

    + NetworkManager does not log any secrets. However, you are advised to check whether anything + private sensitive gets logged before posting. When reporting an issue, provide complete + logs and avoid modifications (for privacy) that distort the meaning. +

/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.
+ 
 
 
 
diff --git a/docs/api/settings-spec.xml b/docs/api/settings-spec.xml
index 749c952b..a0c97185 100644
--- a/docs/api/settings-spec.xml
+++ b/docs/api/settings-spec.xml
@@ -1,107 +1,107 @@
 
 
-Configuration SettingsconnectionGeneral Connection Profile Settings
+<chapter><title>Configuration Settingsconnection General Connection Profile Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionauth-retriesauth-retriesint32-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.autoconnectautoconnectbooleanTRUEWhether 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-priorityautoconnect-priorityint320The 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-retriesautoconnect-retriesint32-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.autoconnect-slavesautoconnect-slavesNMSettingConnectionAutoconnectSlaves (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-tlsdns-over-tlsint32-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.gateway-ping-timeoutgateway-ping-timeoutuint320If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.ididstringA human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".interface-nameinterface-namestringThe 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.lldplldpint32-1Whether LLDP is enabled for the connection.llmnrllmnrint32-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.mastermasterstringInterface name of the master device or UUID of the master connection.mdnsmdnsint32-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.meteredmeteredNMMetered (int32)Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately.mud-urlmud-urlstringIf 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-connectmulti-connectint320Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.permissionspermissionsarray of stringAn 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-onlyread-onlybooleanFALSEFALSE 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.secondariessecondariesarray of stringList of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.slave-typeslave-typestringSetting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.stable-idstable-idstringThis 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.timestamptimestampuint640The 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).typetypestringBase 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).uuiduuidstringA 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-device-timeoutwait-device-timeoutint32-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.zonezonestringThe 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.
6lowpan6LoWPAN Settings
+        Key NameValue TypeDefault ValueValue Descriptionauth-retriesauth-retriesint32-1autoconnectautoconnectbooleanTRUEautoconnect-priorityautoconnect-priorityint320autoconnect-retriesautoconnect-retriesint32-1autoconnect-slavesautoconnect-slavesNMSettingConnectionAutoconnectSlaves (int32)dns-over-tlsdns-over-tlsint32-1gateway-ping-timeoutgateway-ping-timeoutuint320ididstringinterface-nameinterface-namestringlldplldpint32-1llmnrllmnrint32-1mastermasterstringmdnsmdnsint32-1meteredmeteredNMMetered (int32)mptcp-flagsmptcp-flagsuint320mud-urlmud-urlstringmulti-connectmulti-connectint320permissionspermissionsarray of stringread-onlyread-onlybooleanFALSEsecondariessecondariesarray of stringslave-typeslave-typestringstable-idstable-idstringtimestamptimestampuint640typetypestringuuiduuidstringwait-activation-delaywait-activation-delayint32-1wait-device-timeoutwait-device-timeoutint32-1zonezonestring
6lowpan 6LoWPAN Settings
             Properties
-        Key NameValue TypeDefault ValueValue DescriptionparentparentstringIf given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.
802-1xIEEE 802.1x Authentication Settings
+        Key NameValue TypeDefault ValueValue Descriptionparentparentstring
802-1x IEEE 802.1x Authentication Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionaltsubject-matchesaltsubject-matchesarray of stringList 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-identityanonymous-identitystringAnonymous identity string for EAP authentication methods.  Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.auth-timeoutauth-timeoutint320A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.ca-certca-certbyte arrayContains 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-passwordca-cert-passwordstringThe 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-flagsca-cert-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "ca-cert-password" property.ca-pathca-pathstringUTF-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-certclient-certbyte arrayContains 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-passwordclient-cert-passwordstringThe 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-flagsclient-cert-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "client-cert-password" property.domain-matchdomain-matchstringConstraint 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-matchdomain-suffix-matchstringConstraint 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.eapeaparray of stringThe 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.identityidentitystringIdentity string for EAP authentication methods.  Often the user's user or login name.optionaloptionalbooleanFALSEWhether 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-filepac-filestringUTF-8 encoded file path containing PAC for EAP-FAST.passwordpasswordstringUTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.password-flagspassword-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property.password-rawpassword-rawbyte arrayPassword 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-flagspassword-raw-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password-raw" property.phase1-auth-flagsphase1-auth-flagsuint320Specifies 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-provisioningphase1-fast-provisioningstringEnables 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-peaplabelphase1-peaplabelstringForces 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-peapverphase1-peapverstringForces 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-matchesphase2-altsubject-matchesarray of stringList 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-authphase2-authstringSpecifies 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-autheapphase2-autheapstringSpecifies 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-certphase2-ca-certbyte arrayContains 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-passwordphase2-ca-cert-passwordstringThe 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-flagsphase2-ca-cert-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "phase2-ca-cert-password" property.phase2-ca-pathphase2-ca-pathstringUTF-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-certphase2-client-certbyte arrayContains 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-passwordphase2-client-cert-passwordstringThe 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-flagsphase2-client-cert-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "phase2-client-cert-password" property.phase2-domain-matchphase2-domain-matchstringConstraint 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-matchphase2-domain-suffix-matchstringConstraint 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-keyphase2-private-keybyte arrayContains 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-passwordphase2-private-key-passwordstringThe 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-flagsphase2-private-key-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "phase2-private-key-password" property.phase2-subject-matchphase2-subject-matchstringSubstring 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.pinpinstringPIN used for EAP authentication methods.pin-flagspin-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "pin" property.private-keyprivate-keybyte arrayContains 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-passwordprivate-key-passwordstringThe 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-flagsprivate-key-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "private-key-password" property.subject-matchsubject-matchstringSubstring 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-certssystem-ca-certsbooleanFALSEWhen 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).
adslADSL Settings
+        Key NameValue TypeDefault ValueValue Descriptionaltsubject-matchesaltsubject-matchesarray of stringanonymous-identityanonymous-identitystringauth-timeoutauth-timeoutint320ca-certca-certbyte arrayca-cert-passwordca-cert-passwordstringca-cert-password-flagsca-cert-password-flagsNMSettingSecretFlags (uint32)ca-pathca-pathstringclient-certclient-certbyte arrayclient-cert-passwordclient-cert-passwordstringclient-cert-password-flagsclient-cert-password-flagsNMSettingSecretFlags (uint32)domain-matchdomain-matchstringdomain-suffix-matchdomain-suffix-matchstringeapeaparray of stringidentityidentitystringoptionaloptionalbooleanFALSEpac-filepac-filestringpasswordpasswordstringpassword-flagspassword-flagsNMSettingSecretFlags (uint32)password-rawpassword-rawbyte arraypassword-raw-flagspassword-raw-flagsNMSettingSecretFlags (uint32)phase1-auth-flagsphase1-auth-flagsuint320phase1-fast-provisioningphase1-fast-provisioningstringphase1-peaplabelphase1-peaplabelstringphase1-peapverphase1-peapverstringphase2-altsubject-matchesphase2-altsubject-matchesarray of stringphase2-authphase2-authstringphase2-autheapphase2-autheapstringphase2-ca-certphase2-ca-certbyte arrayphase2-ca-cert-passwordphase2-ca-cert-passwordstringphase2-ca-cert-password-flagsphase2-ca-cert-password-flagsNMSettingSecretFlags (uint32)phase2-ca-pathphase2-ca-pathstringphase2-client-certphase2-client-certbyte arrayphase2-client-cert-passwordphase2-client-cert-passwordstringphase2-client-cert-password-flagsphase2-client-cert-password-flagsNMSettingSecretFlags (uint32)phase2-domain-matchphase2-domain-matchstringphase2-domain-suffix-matchphase2-domain-suffix-matchstringphase2-private-keyphase2-private-keybyte arrayphase2-private-key-passwordphase2-private-key-passwordstringphase2-private-key-password-flagsphase2-private-key-password-flagsNMSettingSecretFlags (uint32)phase2-subject-matchphase2-subject-matchstringpinpinstringpin-flagspin-flagsNMSettingSecretFlags (uint32)private-keyprivate-keybyte arrayprivate-key-passwordprivate-key-passwordstringprivate-key-password-flagsprivate-key-password-flagsNMSettingSecretFlags (uint32)subject-matchsubject-matchstringsystem-ca-certssystem-ca-certsbooleanFALSE
adsl ADSL Settings
             Properties
-        Key NameValue TypeDefault ValueValue DescriptionencapsulationencapsulationstringEncapsulation of ADSL connection.  Can be "vcmux" or "llc".passwordpasswordstringPassword used to authenticate with the ADSL service.password-flagspassword-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property.protocolprotocolstringADSL connection protocol.  Can be "pppoa", "pppoe" or "ipoatm".usernameusernamestringUsername used to authenticate with the ADSL service.vcivciuint320VCI of ADSL connectionvpivpiuint320VPI of ADSL connection
bluetoothBluetooth Settings
+        Key NameValue TypeDefault ValueValue Descriptionencapsulationencapsulationstringpasswordpasswordstringpassword-flagspassword-flagsNMSettingSecretFlags (uint32)protocolprotocolstringusernameusernamestringvcivciuint320vpivpiuint320
bluetooth Bluetooth Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionbdaddrbdaddrbyte arrayThe Bluetooth address of the device.typetypestringEither "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.
bondBonding Settings
+        Key NameValue TypeDefault ValueValue Descriptionbdaddrbdaddrbyte arraytypetypestring
bond Bonding Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptioninterface-nameinterface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bond's interface name.optionsoptionsdict 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]).
bridgeBridging Settings
+        Key NameValue TypeDefault ValueValue Descriptioninterface-nameinterface-namestringoptionsoptionsdict of string to string{'mode': 'balance-rr'}
bridge Bridging Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionageing-timeageing-timeuint32300The Ethernet MAC address aging time, in seconds.forward-delayforward-delayuint3215The Spanning Tree Protocol (STP) forwarding delay, in seconds.group-addressgroup-addressbyte arrayIf 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-maskgroup-forward-maskuint320A 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-timehello-timeuint322The Spanning Tree Protocol (STP) hello time, in seconds.interface-nameinterface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bridge's interface name.mac-addressmac-addressbyte arrayIf 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: 1max-agemax-ageuint3220The Spanning Tree Protocol (STP) maximum message age, in seconds.multicast-hash-maxmulticast-hash-maxuint324096Set maximum size of multicast hash table (value must be a power of 2).multicast-last-member-countmulticast-last-member-countuint322Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.multicast-last-member-intervalmulticast-last-member-intervaluint64100Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.multicast-membership-intervalmulticast-membership-intervaluint6426000Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.multicast-queriermulticast-querierbooleanFALSEEnable or disable sending of multicast queries by the bridge. If not specified the option is disabled.multicast-querier-intervalmulticast-querier-intervaluint6425500If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.multicast-query-intervalmulticast-query-intervaluint6412500Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.multicast-query-response-intervalmulticast-query-response-intervaluint641000Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.multicast-query-use-ifaddrmulticast-query-use-ifaddrbooleanFALSEIf 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-routermulticast-routerstringSets 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-snoopingmulticast-snoopingbooleanTRUEControls 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-countmulticast-startup-query-countuint322Set the number of IGMP queries to send during startup phase.multicast-startup-query-intervalmulticast-startup-query-intervaluint643125Sets the time (in deciseconds) between queries sent out at startup to determine membership information.prioritypriorityuint3232768Sets the Spanning Tree Protocol (STP) priority for this bridge.  Lower values are "better"; the lowest priority bridge will be elected the root bridge.stpstpbooleanTRUEControls whether Spanning Tree Protocol (STP) is enabled for this bridge.vlan-default-pvidvlan-default-pviduint321The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.vlan-filteringvlan-filteringbooleanFALSEControl whether VLAN filtering is enabled on the bridge.vlan-protocolvlan-protocolstringIf 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-enabledvlan-stats-enabledbooleanFALSEControls whether per-VLAN stats accounting is enabled.vlansvlansarray of vardictArray 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.
bridge-portBridge Port Settings
+        Key NameValue TypeDefault ValueValue Descriptionageing-timeageing-timeuint32300forward-delayforward-delayuint3215group-addressgroup-addressbyte arraygroup-forward-maskgroup-forward-maskuint320hello-timehello-timeuint322interface-nameinterface-namestringmac-addressmac-addressbyte arraymax-agemax-ageuint3220multicast-hash-maxmulticast-hash-maxuint324096multicast-last-member-countmulticast-last-member-countuint322multicast-last-member-intervalmulticast-last-member-intervaluint64100multicast-membership-intervalmulticast-membership-intervaluint6426000multicast-queriermulticast-querierbooleanFALSEmulticast-querier-intervalmulticast-querier-intervaluint6425500multicast-query-intervalmulticast-query-intervaluint6412500multicast-query-response-intervalmulticast-query-response-intervaluint641000multicast-query-use-ifaddrmulticast-query-use-ifaddrbooleanFALSEmulticast-routermulticast-routerstringmulticast-snoopingmulticast-snoopingbooleanTRUEmulticast-startup-query-countmulticast-startup-query-countuint322multicast-startup-query-intervalmulticast-startup-query-intervaluint643125prioritypriorityuint3232768stpstpbooleanTRUEvlan-default-pvidvlan-default-pviduint321vlan-filteringvlan-filteringbooleanFALSEvlan-protocolvlan-protocolstringvlan-stats-enabledvlan-stats-enabledbooleanFALSEvlansvlansarray of vardict
bridge-port Bridge Port Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionhairpin-modehairpin-modebooleanFALSEEnables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.path-costpath-costuint32100The Spanning Tree Protocol (STP) port cost for destinations via this port.prioritypriorityuint3232The Spanning Tree Protocol (STP) priority of this bridge port.vlansvlansarray of vardictArray 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.
cdmaCDMA-based Mobile Broadband Settings
+        Key NameValue TypeDefault ValueValue Descriptionhairpin-modehairpin-modebooleanFALSEpath-costpath-costuint32100prioritypriorityuint3232vlansvlansarray of vardict
cdma CDMA-based Mobile Broadband Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionmtumtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.numbernumberstringThe 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.passwordpasswordstringThe 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-flagspassword-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property.usernameusernamestringThe 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.
dcbData Center Bridging Settings
+        Key NameValue TypeDefault ValueValue Descriptionmtumtuuint320numbernumberstringpasswordpasswordstringpassword-flagspassword-flagsNMSettingSecretFlags (uint32)usernameusernamestring
dcb Data Center Bridging Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionapp-fcoe-flagsapp-fcoe-flagsNMSettingDcbFlags (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-modeapp-fcoe-modestringThe 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-priorityapp-fcoe-priorityint32-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.app-fip-flagsapp-fip-flagsNMSettingDcbFlags (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-priorityapp-fip-priorityint32-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.app-iscsi-flagsapp-iscsi-flagsNMSettingDcbFlags (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-priorityapp-iscsi-priorityint32-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.priority-bandwidthpriority-bandwidtharray of uint32An 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-controlpriority-flow-controlarray of uint32An 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-flagspriority-flow-control-flagsNMSettingDcbFlags (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-bandwidthpriority-group-bandwidtharray of uint32An 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-flagspriority-group-flagsNMSettingDcbFlags (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-idpriority-group-idarray of uint32An 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-bandwidthpriority-strict-bandwidtharray of uint32An 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-classpriority-traffic-classarray of uint32An 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.
dummyDummy Link Settings
+        Key NameValue TypeDefault ValueValue Descriptionapp-fcoe-flagsapp-fcoe-flagsNMSettingDcbFlags (uint32)app-fcoe-modeapp-fcoe-modestringapp-fcoe-priorityapp-fcoe-priorityint32-1app-fip-flagsapp-fip-flagsNMSettingDcbFlags (uint32)app-fip-priorityapp-fip-priorityint32-1app-iscsi-flagsapp-iscsi-flagsNMSettingDcbFlags (uint32)app-iscsi-priorityapp-iscsi-priorityint32-1priority-bandwidthpriority-bandwidtharray of uint32priority-flow-controlpriority-flow-controlarray of uint32priority-flow-control-flagspriority-flow-control-flagsNMSettingDcbFlags (uint32)priority-group-bandwidthpriority-group-bandwidtharray of uint32priority-group-flagspriority-group-flagsNMSettingDcbFlags (uint32)priority-group-idpriority-group-idarray of uint32priority-strict-bandwidthpriority-strict-bandwidtharray of uint32priority-traffic-classpriority-traffic-classarray of uint32
dummy Dummy Link Settings
             Properties
-        Key NameValue TypeDefault ValueValue Description
ethtoolEthtool Ethernet Settings
+        Key NameValue TypeDefault ValueValue Description
ethtool Ethtool Ethernet Settings
             Properties
-        Key NameValue TypeDefault ValueValue Description
genericGeneric Link Settings
+        Key NameValue TypeDefault ValueValue Description
generic Generic Link Settings
             Properties
-        Key NameValue TypeDefault ValueValue Description
gsmGSM-based Mobile Broadband Settings
+        Key NameValue TypeDefault ValueValue Description
gsm GSM-based Mobile Broadband Settings
             Properties
-        Key NameValue TypeDefault ValueValue DescriptionapnapnstringThe 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-configauto-configbooleanFALSEWhen 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-iddevice-idstringThe 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-onlyhome-onlybooleanFALSEWhen TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.mtumtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.network-idnetwork-idstringThe 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.numbernumberstringLegacy setting that used to help establishing PPP data sessions for GSM-based modems. Deprecated: 1passwordpasswordstringThe 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-flagspassword-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property.pinpinstringIf 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-flagspin-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "pin" property.sim-idsim-idstringThe 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-idsim-operator-idstringA 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.usernameusernamestringThe 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.
infinibandInfiniband Settings
+        Key NameValue TypeDefault ValueValue Descriptionapnapnstringauto-configauto-configbooleanFALSEdevice-iddevice-idstringhome-onlyhome-onlybooleanFALSEmtumtuuint320network-idnetwork-idstringnumbernumberstringpasswordpasswordstringpassword-flagspassword-flagsNMSettingSecretFlags (uint32)pinpinstringpin-flagspin-flagsNMSettingSecretFlags (uint32)sim-idsim-idstringsim-operator-idsim-operator-idstringusernameusernamestring
infiniband Infiniband Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionmac-addressmac-addressbyte arrayIf 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).mtumtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.p-keyp-keyint32-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.parentparentstringThe 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-modetransport-modestringThe IP-over-InfiniBand transport mode. Either "datagram" or "connected".
ipv4IPv4 Settings
+        Key NameValue TypeDefault ValueValue Descriptionmac-addressmac-addressbyte arraymtumtuuint320p-keyp-keyint32-1parentparentstringtransport-modetransport-modestring
ipv4 IPv4 Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionaddress-dataaddress-dataarray of vardictArray 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.addressesaddressesarray of array of uint32Deprecated 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-timeoutdad-timeoutint32-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.dhcp-client-iddhcp-client-idstringA 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-fqdndhcp-fqdnstringIf 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-hostnamedhcp-hostnamestringIf 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-flagsdhcp-hostname-flagsuint320Flags 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-iaiddhcp-iaidstringA 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-serversdhcp-reject-serversarray of stringArray 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-hostnamedhcp-send-hostnamebooleanTRUEIf 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-timeoutdhcp-timeoutint320A 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-identifierdhcp-vendor-class-identifierstringThe 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.28dnsdnsarray of uint32Array of IP addresses of DNS servers (as network-byte-order integers)dns-optionsdns-optionsarray of stringArray 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-prioritydns-priorityint320DNS 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-searchdns-searcharray of stringArray 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.gatewaygatewaystringThe 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-dnsignore-auto-dnsbooleanFALSEWhen "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-routesignore-auto-routesbooleanFALSEWhen "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.may-failmay-failbooleanTRUEIf 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.methodmethodstringIP 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-defaultnever-defaultbooleanFALSEIf 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-timeoutrequired-timeoutint32-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).route-dataroute-dataarray of vardictArray 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-metricroute-metricint64-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.route-tableroute-tableuint320Enable 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.routesroutesarray of array of uint32Deprecated 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.)
ipv6IPv6 Settings
+        Key NameValue TypeDefault ValueValue Descriptionaddress-dataaddress-dataarray of vardictaddressesaddressesarray of array of uint32dad-timeoutdad-timeoutint32-1dhcp-client-iddhcp-client-idstringdhcp-fqdndhcp-fqdnstringdhcp-hostnamedhcp-hostnamestringdhcp-hostname-flagsdhcp-hostname-flagsuint320dhcp-iaiddhcp-iaidstringdhcp-reject-serversdhcp-reject-serversarray of stringdhcp-send-hostnamedhcp-send-hostnamebooleanTRUEdhcp-timeoutdhcp-timeoutint320dhcp-vendor-class-identifierdhcp-vendor-class-identifierstringdnsdnsarray of uint32dns-optionsdns-optionsarray of stringdns-prioritydns-priorityint320dns-searchdns-searcharray of stringgatewaygatewaystringignore-auto-dnsignore-auto-dnsbooleanFALSEignore-auto-routesignore-auto-routesbooleanFALSElink-locallink-localint320may-failmay-failbooleanTRUEmethodmethodstringnever-defaultnever-defaultbooleanFALSErequired-timeoutrequired-timeoutint32-1route-dataroute-dataarray of vardictroute-metricroute-metricint64-1route-tableroute-tableuint320routesroutesarray of array of uint32
ipv6 IPv6 Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionaddr-gen-modeaddr-gen-modeint321Configure 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.address-dataaddress-dataarray of vardictArray 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.addressesaddressesarray 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-timeoutdad-timeoutint32-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.dhcp-duiddhcp-duidstringA 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-hostnamedhcp-hostnamestringIf 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-flagsdhcp-hostname-flagsuint320Flags 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-iaiddhcp-iaidstringA 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-serversdhcp-reject-serversarray of stringArray 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-hostnamedhcp-send-hostnamebooleanTRUEIf 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-timeoutdhcp-timeoutint320A 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.dnsdnsarray of byte arrayArray of IP addresses of DNS servers (in network byte order)dns-optionsdns-optionsarray of stringArray 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-prioritydns-priorityint320DNS 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-searchdns-searcharray of stringArray 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.gatewaygatewaystringThe 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-dnsignore-auto-dnsbooleanFALSEWhen "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-routesignore-auto-routesbooleanFALSEWhen "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-privacyip6-privacyNMSettingIP6ConfigPrivacy (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-failmay-failbooleanTRUEIf 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.methodmethodstringIP 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-defaultnever-defaultbooleanFALSEIf 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-timeoutra-timeoutint320A 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-timeoutrequired-timeoutint32-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).route-dataroute-dataarray of vardictArray 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-metricroute-metricint64-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.route-tableroute-tableuint320Enable 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.routesroutesarray 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.tokentokenstringConfigure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.
ip-tunnelIP Tunneling Settings
+        Key NameValue TypeDefault ValueValue Descriptionaddr-gen-modeaddr-gen-modeint323address-dataaddress-dataarray of vardictaddressesaddressesarray of legacy IPv6 address struct (a(ayuay))dad-timeoutdad-timeoutint32-1dhcp-duiddhcp-duidstringdhcp-hostnamedhcp-hostnamestringdhcp-hostname-flagsdhcp-hostname-flagsuint320dhcp-iaiddhcp-iaidstringdhcp-reject-serversdhcp-reject-serversarray of stringdhcp-send-hostnamedhcp-send-hostnamebooleanTRUEdhcp-timeoutdhcp-timeoutint320dnsdnsarray of byte arraydns-optionsdns-optionsarray of stringdns-prioritydns-priorityint320dns-searchdns-searcharray of stringgatewaygatewaystringignore-auto-dnsignore-auto-dnsbooleanFALSEignore-auto-routesignore-auto-routesbooleanFALSEip6-privacyip6-privacyNMSettingIP6ConfigPrivacy (int32)may-failmay-failbooleanTRUEmethodmethodstringmtumtuuint320never-defaultnever-defaultbooleanFALSEra-timeoutra-timeoutint320required-timeoutrequired-timeoutint32-1route-dataroute-dataarray of vardictroute-metricroute-metricint64-1route-tableroute-tableuint320routesroutesarray of legacy IPv6 route struct (a(ayuayu))tokentokenstring
ip-tunnel IP Tunneling Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionencapsulation-limitencapsulation-limituint320How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.flagsflagsuint320Tunnel 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-labelflow-labeluint320The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.input-keyinput-keystringThe key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.locallocalstringThe local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.modemodeuint320The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).mtumtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.output-keyoutput-keystringThe key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.parentparentstringIf 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-discoverypath-mtu-discoverybooleanTRUEWhether to enable Path MTU Discovery on this tunnel.remoteremotestringThe remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.tostosuint320The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.ttlttluint320The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.
macsecMACSec Settings
+        Key NameValue TypeDefault ValueValue Descriptionencapsulation-limitencapsulation-limituint320flagsflagsuint320flow-labelflow-labeluint320input-keyinput-keystringlocallocalstringmodemodeuint320mtumtuuint320output-keyoutput-keystringparentparentstringpath-mtu-discoverypath-mtu-discoverybooleanTRUEremoteremotestringtostosuint320ttlttluint320
macsec MACSec Settings
             Properties
-        Key NameValue TypeDefault ValueValue DescriptionencryptencryptbooleanTRUEWhether the transmitted traffic must be encrypted.mka-cakmka-cakstringThe pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement.mka-cak-flagsmka-cak-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "mka-cak" property.mka-cknmka-cknstringThe pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement.modemodeint320Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.parentparentstringIf 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.portportint321The port component of the SCI (Secure Channel Identifier), between 1 and 65534.send-scisend-scibooleanTRUESpecifies whether the SCI (Secure Channel Identifier) is included in every packet.validationvalidationint322Specifies the validation mode for incoming frames.
macvlanMAC VLAN Settings
+        Key NameValue TypeDefault ValueValue DescriptionencryptencryptbooleanTRUEmka-cakmka-cakstringmka-cak-flagsmka-cak-flagsNMSettingSecretFlags (uint32)mka-cknmka-cknstringmodemodeint320parentparentstringportportint321send-scisend-scibooleanTRUEvalidationvalidationint322
macvlan MAC VLAN Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionmodemodeuint320The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.parentparentstringIf 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.promiscuouspromiscuousbooleanTRUEWhether the interface should be put in promiscuous mode.taptapbooleanFALSEWhether the interface should be a MACVTAP.
matchMatch settings
+        Key NameValue TypeDefault ValueValue Descriptionmodemodeuint320parentparentstringpromiscuouspromiscuousbooleanTRUEtaptapbooleanFALSE
match Match settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptiondriverdriverarray of stringA 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-nameinterface-namearray of stringA 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-linekernel-command-linearray of stringA 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.pathpatharray of stringA 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.
802-11-olpc-meshOLPC Wireless Mesh Settings
+        Key NameValue TypeDefault ValueValue Descriptiondriverdriverarray of stringinterface-nameinterface-namearray of stringkernel-command-linekernel-command-linearray of stringpathpatharray of string
802-11-olpc-mesh OLPC Wireless Mesh Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionchannelchanneluint320Channel on which the mesh network to join is located.dhcp-anycast-addressdhcp-anycast-addressbyte arrayAnycast 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.ssidssidbyte arraySSID of the mesh network to join.
ovs-bridgeOvsBridge Link Settings
+        Key NameValue TypeDefault ValueValue Descriptionchannelchanneluint320dhcp-anycast-addressdhcp-anycast-addressbyte arrayssidssidbyte array
ovs-bridge OvsBridge Link Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptiondatapath-typedatapath-typestringThe data path type. One of "system", "netdev" or empty.fail-modefail-modestringThe bridge failure mode. One of "secure", "standalone" or empty.mcast-snooping-enablemcast-snooping-enablebooleanFALSEEnable or disable multicast snooping.rstp-enablerstp-enablebooleanFALSEEnable or disable RSTP.stp-enablestp-enablebooleanFALSEEnable or disable STP.
ovs-dpdkOvsDpdk Link Settings
+        Key NameValue TypeDefault ValueValue Descriptiondatapath-typedatapath-typestringfail-modefail-modestringmcast-snooping-enablemcast-snooping-enablebooleanFALSErstp-enablerstp-enablebooleanFALSEstp-enablestp-enablebooleanFALSE
ovs-dpdk OvsDpdk Link Settings
             Properties
-        Key NameValue TypeDefault ValueValue DescriptiondevargsdevargsstringOpen vSwitch DPDK device arguments.n-rxqn-rxquint320Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.
ovs-interfaceOpen vSwitch Interface Settings
+        Key NameValue TypeDefault ValueValue Descriptiondevargsdevargsstringn-rxqn-rxquint320
ovs-interface Open vSwitch Interface Settings
             Properties
-        Key NameValue TypeDefault ValueValue DescriptiontypetypestringThe interface type. Either "internal", "system", "patch", "dpdk", or empty.
ovs-patchOvsPatch Link Settings
+        Key NameValue TypeDefault ValueValue Descriptiontypetypestring
ovs-patch OvsPatch Link Settings
             Properties
-        Key NameValue TypeDefault ValueValue DescriptionpeerpeerstringSpecifies 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-portOvsPort Link Settings
+        Key NameValue TypeDefault ValueValue Descriptionpeerpeerstring
ovs-port OvsPort Link Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionbond-downdelaybond-downdelayuint320The time port must be inactive in order to be considered down.bond-modebond-modestringBonding mode. One of "active-backup", "balance-slb", or "balance-tcp".bond-updelaybond-updelayuint320The time port must be active before it starts forwarding traffic.lacplacpstringLACP mode. One of "active", "off", or "passive".tagtaguint320The VLAN tag in the range 0-4095.vlan-modevlan-modestringThe VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk" or unset.
pppPoint-to-Point Protocol Settings
+        Key NameValue TypeDefault ValueValue Descriptionbond-downdelaybond-downdelayuint320bond-modebond-modestringbond-updelaybond-updelayuint320lacplacpstringtagtaguint320vlan-modevlan-modestring
ppp Point-to-Point Protocol Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionbaudbauduint320If 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.crtsctscrtsctsbooleanFALSEIf 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-failurelcp-echo-failureuint320If 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-intervallcp-echo-intervaluint320If 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-statefulmppe-statefulbooleanFALSEIf TRUE, stateful MPPE is used.  See pppd documentation for more information on stateful MPPE.mrumruuint320If 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.mtumtuuint320If non-zero, instruct pppd to send packets no larger than the specified size.no-vj-compno-vj-compbooleanFALSEIf TRUE, Van Jacobsen TCP header compression will not be requested.noauthnoauthbooleanTRUEIf 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.nobsdcompnobsdcompbooleanFALSEIf TRUE, BSD compression will not be requested.nodeflatenodeflatebooleanFALSEIf TRUE, "deflate" compression will not be requested.refuse-chaprefuse-chapbooleanFALSEIf TRUE, the CHAP authentication method will not be used.refuse-eaprefuse-eapbooleanFALSEIf TRUE, the EAP authentication method will not be used.refuse-mschaprefuse-mschapbooleanFALSEIf TRUE, the MSCHAP authentication method will not be used.refuse-mschapv2refuse-mschapv2booleanFALSEIf TRUE, the MSCHAPv2 authentication method will not be used.refuse-paprefuse-papbooleanFALSEIf TRUE, the PAP authentication method will not be used.require-mpperequire-mppebooleanFALSEIf 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-128require-mppe-128booleanFALSEIf 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.
pppoePPP-over-Ethernet Settings
+        Key NameValue TypeDefault ValueValue Descriptionbaudbauduint320crtsctscrtsctsbooleanFALSElcp-echo-failurelcp-echo-failureuint320lcp-echo-intervallcp-echo-intervaluint320mppe-statefulmppe-statefulbooleanFALSEmrumruuint320mtumtuuint320no-vj-compno-vj-compbooleanFALSEnoauthnoauthbooleanTRUEnobsdcompnobsdcompbooleanFALSEnodeflatenodeflatebooleanFALSErefuse-chaprefuse-chapbooleanFALSErefuse-eaprefuse-eapbooleanFALSErefuse-mschaprefuse-mschapbooleanFALSErefuse-mschapv2refuse-mschapv2booleanFALSErefuse-paprefuse-papbooleanFALSErequire-mpperequire-mppebooleanFALSErequire-mppe-128require-mppe-128booleanFALSE
pppoe PPP-over-Ethernet Settings
             Properties
-        Key NameValue TypeDefault ValueValue DescriptionparentparentstringIf 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.passwordpasswordstringPassword used to authenticate with the PPPoE service.password-flagspassword-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property.serviceservicestringIf 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.usernameusernamestringUsername used to authenticate with the PPPoE service.
proxyWWW Proxy Settings
+        Key NameValue TypeDefault ValueValue Descriptionparentparentstringpasswordpasswordstringpassword-flagspassword-flagsNMSettingSecretFlags (uint32)serviceservicestringusernameusernamestring
proxy WWW Proxy Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionbrowser-onlybrowser-onlybooleanFALSEWhether the proxy configuration is for browser only.methodmethodint320Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)pac-scriptpac-scriptstringPAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.pac-urlpac-urlstringPAC URL for obtaining PAC file.
serialSerial Link Settings
+        Key NameValue TypeDefault ValueValue Descriptionbrowser-onlybrowser-onlybooleanFALSEmethodmethodint320pac-scriptpac-scriptstringpac-urlpac-urlstring
serial Serial Link Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionbaudbauduint3257600Speed 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.bitsbitsuint328Byte-width of the serial communication. The 8 in "8n1" for example.parityparitybyteThe connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none.send-delaysend-delayuint640Time to delay between each byte sent to the modem, in microseconds.stopbitsstopbitsuint321Number of stop bits for communication on the serial port.  Either 1 or 2. The 1 in "8n1" for example.
sriovSR-IOV settings
+        Key NameValue TypeDefault ValueValue Descriptionbaudbauduint3257600bitsbitsuint328parityparitybytesend-delaysend-delayuint640stopbitsstopbitsuint321
sriov SR-IOV settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionautoprobe-driversautoprobe-driversNMTernary (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-vfstotal-vfsuint320The 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.vfsvfsarray of vardictArray 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.
tcLinux Traffic Control Settings
+        Key NameValue TypeDefault ValueValue Descriptionautoprobe-driversautoprobe-driversNMTernary (int32)total-vfstotal-vfsuint320vfsvfsarray of vardict
tc Linux Traffic Control Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionqdiscsqdiscsarray of vardictArray 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.tfilterstfiltersarray of vardictArray 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.
teamTeaming Settings
+        Key NameValue TypeDefault ValueValue Descriptionqdiscsqdiscsarray of vardicttfilterstfiltersarray of vardict
team Teaming Settings
             Properties
-        Key NameValue TypeDefault ValueValue DescriptionconfigconfigstringThe 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-nameinterface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name.link-watcherslink-watchersarray of vardictLink 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-countmcast-rejoin-countint32-1Corresponds to the teamd mcast_rejoin.count.mcast-rejoin-intervalmcast-rejoin-intervalint32-1Corresponds to the teamd mcast_rejoin.interval.notify-peers-countnotify-peers-countint32-1Corresponds to the teamd notify_peers.count.notify-peers-intervalnotify-peers-intervalint32-1Corresponds to the teamd notify_peers.interval.runnerrunnerstringCorresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".runner-activerunner-activebooleanTRUECorresponds to the teamd runner.active.runner-agg-select-policyrunner-agg-select-policystringCorresponds to the teamd runner.agg_select_policy.runner-fast-raterunner-fast-ratebooleanFALSECorresponds to the teamd runner.fast_rate.runner-hwaddr-policyrunner-hwaddr-policystringCorresponds to the teamd runner.hwaddr_policy.runner-min-portsrunner-min-portsint32-1Corresponds to the teamd runner.min_ports.runner-sys-priorunner-sys-prioint32-1Corresponds to the teamd runner.sys_prio.runner-tx-balancerrunner-tx-balancerstringCorresponds to the teamd runner.tx_balancer.name.runner-tx-balancer-intervalrunner-tx-balancer-intervalint32-1Corresponds to the teamd runner.tx_balancer.interval.runner-tx-hashrunner-tx-hasharray of stringCorresponds to the teamd runner.tx_hash.
team-portTeam Port Settings
+        Key NameValue TypeDefault ValueValue Descriptionconfigconfigstringinterface-nameinterface-namestringlink-watcherslink-watchersarray of vardictmcast-rejoin-countmcast-rejoin-countint32-1mcast-rejoin-intervalmcast-rejoin-intervalint32-1notify-peers-countnotify-peers-countint32-1notify-peers-intervalnotify-peers-intervalint32-1runnerrunnerstringrunner-activerunner-activebooleanTRUErunner-agg-select-policyrunner-agg-select-policystringrunner-fast-raterunner-fast-ratebooleanFALSErunner-hwaddr-policyrunner-hwaddr-policystringrunner-min-portsrunner-min-portsint32-1runner-sys-priorunner-sys-prioint32-1runner-tx-balancerrunner-tx-balancerstringrunner-tx-balancer-intervalrunner-tx-balancer-intervalint32-1runner-tx-hashrunner-tx-hasharray of string
team-port Team Port Settings
             Properties
-        Key NameValue TypeDefault ValueValue DescriptionconfigconfigstringThe 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-keylacp-keyint32-1Corresponds to the teamd ports.PORTIFNAME.lacp_key.lacp-priolacp-prioint32-1Corresponds to the teamd ports.PORTIFNAME.lacp_prio.link-watcherslink-watchersarray of vardictLink 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.prioprioint320Corresponds to the teamd ports.PORTIFNAME.prio.queue-idqueue-idint32-1Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.stickystickybooleanFALSECorresponds to the teamd ports.PORTIFNAME.sticky.
tunTunnel Settings
+        Key NameValue TypeDefault ValueValue Descriptionconfigconfigstringlacp-keylacp-keyint32-1lacp-priolacp-prioint32-1link-watcherslink-watchersarray of vardictprioprioint320queue-idqueue-idint32-1stickystickybooleanFALSE
tun Tunnel Settings
             Properties
-        Key NameValue TypeDefault ValueValue DescriptiongroupgroupstringThe group ID which will own the device. If set to NULL everyone will be able to use the device.modemodeuint321The 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-queuemulti-queuebooleanFALSEIf 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.ownerownerstringThe user ID which will own the device. If set to NULL everyone will be able to use the device.pipibooleanFALSEIf TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.vnet-hdrvnet-hdrbooleanFALSEIf TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.
userGeneral User Profile Settings
+        Key NameValue TypeDefault ValueValue Descriptiongroupgroupstringmodemodeuint321multi-queuemulti-queuebooleanFALSEownerownerstringpipibooleanFALSEvnet-hdrvnet-hdrbooleanFALSE
user General User Profile Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptiondatadatadict 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.
vlanVLAN Settings
+        Key NameValue TypeDefault ValueValue Descriptiondatadatadict of string to string{}
vlan VLAN Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionegress-priority-mapegress-priority-maparray of stringFor 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".flagsflagsNMVlanFlags (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.ididuint320The 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-mapingress-priority-maparray of stringFor 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-nameinterface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name.parentparentstringIf 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.
vpnVPN Settings
+        Key NameValue TypeDefault ValueValue Descriptionegress-priority-mapegress-priority-maparray of stringflagsflagsNMVlanFlags (uint32)ididuint320ingress-priority-mapingress-priority-maparray of stringinterface-nameinterface-namestringparentparentstring
vpn VPN Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptiondatadatadict of string to string{}Dictionary of key/value pairs of VPN plugin specific data.  Both keys and values must be strings.persistentpersistentbooleanFALSEIf 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.secretssecretsdict 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-typeservice-typestringD-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.timeouttimeoutuint320Timeout 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-nameuser-namestringIf 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.
vrfVRF settings
+        Key NameValue TypeDefault ValueValue Descriptiondatadatadict of string to string{}persistentpersistentbooleanFALSEsecretssecretsdict of string to string{}service-typeservice-typestringtimeouttimeoutuint320user-nameuser-namestring
vrf VRF settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptiontabletableuint320The routing table for this VRF.
vxlanVXLAN Settings
+        Key NameValue TypeDefault ValueValue Descriptiontabletableuint320
vxlan VXLAN Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionageingageinguint32300Specifies the lifetime in seconds of FDB entries learnt by the kernel.destination-portdestination-portuint328472Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.ididuint320Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.l2-missl2-missbooleanFALSESpecifies whether netlink LL ADDR miss notifications are generated.l3-missl3-missbooleanFALSESpecifies whether netlink IP ADDR miss notifications are generated.learninglearningbooleanTRUESpecifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.limitlimituint320Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.locallocalstringIf given, specifies the source IP address to use in outgoing packets.parentparentstringIf given, specifies the parent interface name or parent connection UUID.proxyproxybooleanFALSESpecifies whether ARP proxy is turned on.remoteremotestringSpecifies 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.rscrscbooleanFALSESpecifies whether route short circuit is turned on.source-port-maxsource-port-maxuint320Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.source-port-minsource-port-minuint320Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.tostosuint320Specifies the TOS value to use in outgoing packets.ttlttluint320Specifies the time-to-live value to use in outgoing packets.
wifi-p2pWi-Fi P2P Settings
+        Key NameValue TypeDefault ValueValue Descriptionageingageinguint32300destination-portdestination-portuint328472ididuint320l2-missl2-missbooleanFALSEl3-missl3-missbooleanFALSElearninglearningbooleanTRUElimitlimituint320locallocalstringparentparentstringproxyproxybooleanFALSEremoteremotestringrscrscbooleanFALSEsource-port-maxsource-port-maxuint320source-port-minsource-port-minuint320tostosuint320ttlttluint320
wifi-p2p Wi-Fi P2P Settings
             Properties
-        Key NameValue TypeDefault ValueValue DescriptionpeerpeerstringThe P2P device that should be connected to. Currently, this is the only way to create or join a group.wfd-ieswfd-iesbyte arrayThe 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-methodwps-methoduint320Flags 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.
wimaxWiMax Settings
+        Key NameValue TypeDefault ValueValue Descriptionpeerpeerstringwfd-ieswfd-iesbyte arraywps-methodwps-methoduint320
wimax WiMax Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionmac-addressmac-addressbyte arrayIf 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: 1network-namenetwork-namestringNetwork Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1
802-3-ethernetWired Ethernet Settings
+        Key NameValue TypeDefault ValueValue Descriptionmac-addressmac-addressbyte arraynetwork-namenetwork-namestring
802-3-ethernet Wired Ethernet Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionaccept-all-mac-addressesaccept-all-mac-addressesNMTernary (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-addressassigned-mac-addressstringThe 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-negotiateauto-negotiatebooleanFALSEWhen 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-addresscloned-mac-addressbyte arrayThis 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".duplexduplexstringWhen 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-maskgenerate-mac-address-maskstringWith "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-addressmac-addressbyte arrayIf 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-blacklistmac-address-blacklistarray of stringIf 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).mtumtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.portportstringSpecific 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-nettypes390-nettypestrings390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.s390-optionss390-optionsdict 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-subchannelss390-subchannelsarray of stringIdentifies 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.speedspeeduint320When 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-lanwake-on-lanuint321The 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-passwordwake-on-lan-passwordstringIf specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address.  If NULL, no password will be required.
wireguardWireGuard Settings
+        Key NameValue TypeDefault ValueValue Descriptionaccept-all-mac-addressesaccept-all-mac-addressesNMTernary (int32)assigned-mac-addressassigned-mac-addressstringauto-negotiateauto-negotiatebooleanFALSEcloned-mac-addresscloned-mac-addressbyte arrayduplexduplexstringgenerate-mac-address-maskgenerate-mac-address-maskstringmac-addressmac-addressbyte arraymac-address-blacklistmac-address-blacklistarray of stringmtumtuuint320portportstrings390-nettypes390-nettypestrings390-optionss390-optionsdict of string to string{}s390-subchannelss390-subchannelsarray of stringspeedspeeduint320wake-on-lanwake-on-lanuint321wake-on-lan-passwordwake-on-lan-passwordstring
wireguard WireGuard Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionfwmarkfwmarkuint320The 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-routeip4-auto-default-routeNMTernary (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-routeip6-auto-default-routeNMTernary (int32)Like ip4-auto-default-route, but for the IPv6 default route.listen-portlisten-portuint320The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.mtumtuuint320If 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-routespeer-routesbooleanTRUEWhether 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.peerspeersarray of 'a{sv}'Array of dictionaries for the WireGuard peers.private-keyprivate-keystringThe 256 bit private-key in base64 encoding.private-key-flagsprivate-key-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "private-key" property.
802-11-wirelessWi-Fi Settings
+        Key NameValue TypeDefault ValueValue Descriptionfwmarkfwmarkuint320ip4-auto-default-routeip4-auto-default-routeNMTernary (int32)ip6-auto-default-routeip6-auto-default-routeNMTernary (int32)listen-portlisten-portuint320mtumtuuint320peer-routespeer-routesbooleanTRUEpeerspeersarray of 'a{sv}'private-keyprivate-keystringprivate-key-flagsprivate-key-flagsNMSettingSecretFlags (uint32)
802-11-wireless Wi-Fi Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionap-isolationap-isolationNMTernary (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-addressassigned-mac-addressstringThe 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".bandbandstring802.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.bssidbssidbyte arrayIf 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.channelchanneluint320Wireless 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-addresscloned-mac-addressbyte arrayThis 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-maskgenerate-mac-address-maskstringWith "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.hiddenhiddenbooleanFALSEIf 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-addressmac-addressbyte arrayIf 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-blacklistmac-address-blacklistarray of stringA 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-randomizationmac-address-randomizationuint320One 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: 1modemodestringWi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap".  If blank, infrastructure is assumed.mtumtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.powersavepowersaveuint320One 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.raterateuint320If 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.securitysecurityThis 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-bssidsseen-bssidsarray of stringA 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.ssidssidbyte arraySSID of the Wi-Fi network. Must be specified.tx-powertx-poweruint320If 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-wlanwake-on-wlanuint321The 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).
802-11-wireless-securityWi-Fi Security Settings
+        Key NameValue TypeDefault ValueValue Descriptionap-isolationap-isolationNMTernary (int32)assigned-mac-addressassigned-mac-addressstringbandbandstringbssidbssidbyte arraychannelchanneluint320cloned-mac-addresscloned-mac-addressbyte arraygenerate-mac-address-maskgenerate-mac-address-maskstringhiddenhiddenbooleanFALSEmac-addressmac-addressbyte arraymac-address-blacklistmac-address-blacklistarray of stringmac-address-randomizationmac-address-randomizationuint320modemodestringmtumtuuint320powersavepowersaveuint320raterateuint320securitysecurityseen-bssidsseen-bssidsarray of stringssidssidbyte arraytx-powertx-poweruint320wake-on-wlanwake-on-wlanuint321
802-11-wireless-security Wi-Fi Security Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionauth-algauth-algstringWhen 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.filsfilsint320Indicates 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.groupgrouparray of stringA 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-mgmtkey-mgmtstringKey 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-passwordleap-passwordstringThe login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").leap-password-flagsleap-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "leap-password" property.leap-usernameleap-usernamestringThe login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").pairwisepairwisearray of stringA 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".pmfpmfint320Indicates 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.protoprotoarray of stringList 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.pskpskstringPre-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-flagspsk-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "psk" property.wep-key-flagswep-key-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.wep-key-typewep-key-typeNMWepKeyType (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-key0wep-key0stringIndex 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-key1wep-key1stringIndex 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-key2wep-key2stringIndex 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-key3wep-key3stringIndex 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-keyidxwep-tx-keyidxuint320When 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-methodwps-methoduint320Flags 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.
wpanIEEE 802.15.4 (WPAN) MAC Settings
+        Key NameValue TypeDefault ValueValue Descriptionauth-algauth-algstringfilsfilsint320groupgrouparray of stringkey-mgmtkey-mgmtstringleap-passwordleap-passwordstringleap-password-flagsleap-password-flagsNMSettingSecretFlags (uint32)leap-usernameleap-usernamestringpairwisepairwisearray of stringpmfpmfint320protoprotoarray of stringpskpskstringpsk-flagspsk-flagsNMSettingSecretFlags (uint32)wep-key-flagswep-key-flagsNMSettingSecretFlags (uint32)wep-key-typewep-key-typeNMWepKeyType (uint32)wep-key0wep-key0stringwep-key1wep-key1stringwep-key2wep-key2stringwep-key3wep-key3stringwep-tx-keyidxwep-tx-keyidxuint320wps-methodwps-methoduint320
wpan IEEE 802.15.4 (WPAN) MAC Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionchannelchannelint32-1IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".mac-addressmac-addressstringIf specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.pagepageint32-1IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".pan-idpan-iduint3265535IEEE 802.15.4 Personal Area Network (PAN) identifier.short-addressshort-addressuint3265535Short IEEE 802.15.4 address to be used within a restricted environment.
bond-portBond Port Settings
+        Key NameValue TypeDefault ValueValue Descriptionchannelchannelint32-1mac-addressmac-addressstringpagepageint32-1pan-idpan-iduint3265535short-addressshort-addressuint3265535
bond-port Bond Port Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionqueue-idqueue-iduint320The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.
hostnameHostname settings
+        Key NameValue TypeDefault ValueValue Descriptionqueue-idqueue-iduint320
hostname Hostname settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptionfrom-dhcpfrom-dhcpNMTernary (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-lookupfrom-dns-lookupNMTernary (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-defaultonly-from-defaultNMTernary (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).prioritypriorityint320The 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.
ovs-external-idsOVS External IDs Settings
+        Key NameValue TypeDefault ValueValue Descriptionfrom-dhcpfrom-dhcpNMTernary (int32)from-dns-lookupfrom-dns-lookupNMTernary (int32)only-from-defaultonly-from-defaultNMTernary (int32)prioritypriorityint320
ovs-external-ids OVS External IDs Settings
             Properties
-        Key NameValue TypeDefault ValueValue Descriptiondatadatadict of string to string{}A dictionary of key/value pairs with exernal-ids for OVS.
vethVeth Settings
+        Key NameValue TypeDefault ValueValue Descriptiondatadatadict of string to string{}
veth Veth Settings
             Properties
-        Key NameValue TypeDefault ValueValue DescriptionpeerpeerstringThis property specifies the peer interface name of the veth. This property is mandatory.

+        Key NameValue TypeDefault ValueValue Descriptionpeerpeerstring

diff --git a/docs/api/version.xml b/docs/api/version.xml
index c097b6a0..d3781d71 100644
--- a/docs/api/version.xml
+++ b/docs/api/version.xml
@@ -1 +1 @@
-1.38.4
+1.39.90
-- 
cgit 1.3.0-6-gf8a5