nm-settings-dbus − Description of settings and properties of NetworkManager connection profiles on the D−Bus API
NetworkManager is based on a concept of connection profiles, sometimes referred to as connections only. These connection profiles contain a network configuration. When NetworkManager activates a connection profile on a network device the configuration will be applied and an active network connection will be established. Users are free to create as many connection profiles as they see fit. Thus they are flexible in having various network configurations for different networking needs. The connection profiles are handled by NetworkManager via settings service and are exported on D−Bus (/org/freedesktop/NetworkManager/Settings/<num> objects). The conceptual objects can be described as follows:
Connection (profile)
A specific, encapsulated, independent group of settings describing all the configuration required to connect to a specific network. It is referred to by a unique identifier called the UUID. A connection is tied to a one specific device type, but not necessarily a specific hardware device. It is composed of one or more Settings objects.
Setting
A group of related key/value pairs describing a specific piece of a Connection (profile). Settings keys and allowed values are described in the tables below. Keys are also referred to as properties. Developers can find the setting objects and their properties in the libnm−core sources. Look for the *_class_init functions near the bottom of each setting source file.
The settings and properties shown in tables below list all available connection configuration options. However, note that not all settings are applicable to all connection types. NetworkManager provides a command−line tool nmcli that allows direct configuration of the settings and properties according to a connection profile type. nmcli connection editor has also a built−in describe command that can display description of particular settings and properties of this page.
General Connection Profile Settings.
6LoWPAN Settings.
IEEE 802.1x Authentication Settings.
ADSL Settings.
Bluetooth Settings.
Bonding Settings.
Bridging Settings.
Bridge Port Settings.
CDMA−based Mobile Broadband Settings.
Data Center Bridging Settings.
Dummy Link Settings.
Ethtool Ethernet Settings.
Generic Link Settings.
GSM−based Mobile Broadband Settings.
Infiniband Settings.
IPv4 Settings.
IPv6 Settings.
IP Tunneling Settings.
MACSec Settings.
MAC VLAN Settings.
Match settings.
OLPC Wireless Mesh Settings.
OvsBridge Link Settings.
OvsDpdk Link Settings.
Open vSwitch Interface Settings.
OvsPatch Link Settings.
OvsPort Link Settings.
Point−to−Point Protocol Settings.
PPP−over−Ethernet Settings.
WWW Proxy Settings.
Serial Link Settings.
SR−IOV settings.
Linux Traffic Control Settings.
Teaming Settings.
Team Port Settings.
Tunnel Settings.
General User Profile Settings.
VLAN Settings.
VPN Settings.
VRF settings.
VXLAN Settings.
Wi−Fi P2P Settings.
WiMax Settings.
Wired Ethernet Settings.
WireGuard Settings.
Wi−Fi Settings.
Wi−Fi Security Settings.
IEEE 802.15.4 (WPAN) MAC Settings.
Bond Port Settings.
Hostname settings.
Link settings.
Loopback Link Settings.
OVS External IDs Settings.
OVS Other Config Settings.
Veth Settings.
Each password or secret property in a setting has an associated flags property that describes how to handle that secret. The flags property is a bitfield that contains zero or more of the following values logically OR−ed together.
• 0x0 (none) − the system is responsible for providing and storing this secret. This may be required so that secrets are already available before the user logs in. It also commonly means that the secret will be stored in plain text on disk, accessible to root only. For example via the keyfile settings plugin as described in the "PLUGINS" section in NetworkManager.conf(5).
• 0x1 (agent−owned) − a user−session secret agent is responsible for providing and storing this secret; when it is required, agents will be asked to provide it.
• 0x2 (not−saved) − this secret should not be saved but should be requested from the user each time it is required. This flag should be used for One−Time−Pad secrets, PIN codes from hardware tokens, or if the user simply does not want to save the secret.
• 0x4 (not−required) − in some situations it cannot be automatically determined that a secret is required or not. This flag hints that the secret is not required and should not be requested from the user.
/etc/NetworkManager/system−connections or distro plugin−specific location
nm-settings-nmcli(5), nm-settings-keyfile(5), NetworkManager(8), nmcli(1), nmcli-examples(7), NetworkManager.conf(5)