for NetworkManager 1.31.3 The latest version of this documentation can be found on-line at

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You may obtain a copy of the GNU Free Documentation License from the Free Software Foundation by visiting their Web site or by writing to:

  The Free Software Foundation, Inc.,

  51 Franklin Street - Fifth Floor,

  BostonMA 02110-1301,


This manual is the reference documentation for NetworkManager, the standard Linux network management service. It is intended for system administrators and integrators who need to understand the capabilities of NetworkManager, its configuration options, command line tools and the D-Bus API for programmatic control of the service.

The end users NetworkManager should instead refer to respective documentation of their desktop environment of choice.

The application developers who prefer not to use the D-Bus API directly can use the libnm library shipped with NetworkManager or its bindings to a higher level language such as Python, Ruby or Vala via GObject introspection.

I. Manual Pages
NetworkManager — network management daemon
NetworkManager.conf — NetworkManager configuration file
NetworkManager-dispatcher — Dispatch user scripts for NetworkManager
nmcli — command-line tool for controlling NetworkManager
nmcli-examples — usage examples of nmcli
nmtui — Text User Interface for controlling NetworkManager
nm-settings-dbus — Description of settings and properties of NetworkManager connection profiles on the D-Bus API
nm-settings-nmcli — Description of settings and properties of NetworkManager connection profiles for nmcli
nm-settings-keyfile — Description of keyfile settings plugin
nm-settings-ifcfg-rh — Description of ifcfg-rh settings plugin
nm-online — ask NetworkManager whether the network is connected
nm-initrd-generator — early boot NetworkManager configuration generator
nm-cloud-setup — Overview of Automatic Network Configuration in Cloud
nm-openvswitch — overview of NetworkManager Open vSwitch support
II. Network Configuration Setting Specification
Configuration Settings
connection — General Connection Profile Settings
6lowpan — 6LoWPAN Settings
802-1x — IEEE 802.1x Authentication Settings
adsl — ADSL Settings
bluetooth — Bluetooth Settings
bond — Bonding Settings
bridge — Bridging Settings
bridge-port — Bridge Port Settings
cdma — CDMA-based Mobile Broadband Settings
dcb — Data Center Bridging Settings
dummy — Dummy Link Settings
ethtool — Ethtool Ethernet Settings
generic — Generic Link Settings
gsm — GSM-based Mobile Broadband Settings
infiniband — Infiniband Settings
ipv4 — IPv4 Settings
ipv6 — IPv6 Settings
ip-tunnel — IP Tunneling Settings
macsec — MACSec Settings
macvlan — MAC VLAN Settings
match — Match settings
802-11-olpc-mesh — OLPC Wireless Mesh Settings
ovs-bridge — OvsBridge Link Settings
ovs-dpdk — OvsDpdk Link Settings
ovs-interface — Open vSwitch Interface Settings
ovs-patch — OvsPatch Link Settings
ovs-port — OvsPort Link Settings
ppp — Point-to-Point Protocol Settings
pppoe — PPP-over-Ethernet Settings
proxy — WWW Proxy Settings
serial — Serial Link Settings
sriov — SR-IOV settings
tc — Linux Traffic Control Settings
team — Teaming Settings
team-port — Team Port Settings
tun — Tunnel Settings
user — General User Profile Settings
vlan — VLAN Settings
vpn — VPN Settings
vrf — VRF settings
vxlan — VXLAN Settings
wifi-p2p — Wi-Fi P2P Settings
wimax — WiMax Settings
802-3-ethernet — Wired Ethernet Settings
wireguard — WireGuard Settings
802-11-wireless — Wi-Fi Settings
802-11-wireless-security — Wi-Fi Security Settings
wpan — IEEE 802.15.4 (WPAN) MAC Settings
hostname — Hostname settings
ovs-external-ids — OVS External IDs Settings
veth — Veth Settings
Secret flag types
III. D-Bus API Reference
The /org/freedesktop/NetworkManager object
org.freedesktop.NetworkManager — Connection Manager
The /org/freedesktop/NetworkManager/AgentManager object
org.freedesktop.NetworkManager.AgentManager — Secret Agent Manager
The /org/freedesktop/NetworkManager/DnsManager object
org.freedesktop.NetworkManager.DnsManager — DNS Configuration State
The /org/freedesktop/NetworkManager/Settings object
org.freedesktop.NetworkManager.Settings — Connection Settings Profile Manager
The /org/freedesktop/NetworkManager/Settings/* objects
org.freedesktop.NetworkManager.Settings.Connection — Connection Settings Profile
The /org/freedesktop/NetworkManager/Devices/* objects
org.freedesktop.NetworkManager.Device — Device
org.freedesktop.NetworkManager.Device.Statistics — Device Statistic Counters
org.freedesktop.NetworkManager.Device.Adsl — ADSL Device
org.freedesktop.NetworkManager.Device.Bluetooth — Bluetooth Device
org.freedesktop.NetworkManager.Device.Bond — Bonding Device
org.freedesktop.NetworkManager.Device.Bridge — Bridging Device
org.freedesktop.NetworkManager.Device.Dummy — Dummy Device
org.freedesktop.NetworkManager.Device.Generic — Unrecognized Device
org.freedesktop.NetworkManager.Device.IPTunnel — IP Tunneling Device
org.freedesktop.NetworkManager.Device.Infiniband — Infiniband Device
org.freedesktop.NetworkManager.Device.Lowpan — 6LoWPAN Device
org.freedesktop.NetworkManager.Device.Macsec — MACSec Device
org.freedesktop.NetworkManager.Device.Macvlan — MAC VLAN Device
org.freedesktop.NetworkManager.Device.Modem — Modem Device
org.freedesktop.NetworkManager.Device.OlpcMesh — OLPC Wireless Mesh Device
org.freedesktop.NetworkManager.Device.OvsBridge — OvsBridge Device
org.freedesktop.NetworkManager.Device.OvsInterface — OvsInterface Device
org.freedesktop.NetworkManager.Device.OvsPort — OvsPort Device
org.freedesktop.NetworkManager.Device.Ppp — PPP Device
org.freedesktop.NetworkManager.Device.Team — Teaming Device
org.freedesktop.NetworkManager.Device.Tun — Userspace Tunneling Device
org.freedesktop.NetworkManager.Device.Veth — Virtual Ethernet Device
org.freedesktop.NetworkManager.Device.Vlan — Virtual LAN Device
org.freedesktop.NetworkManager.Device.Vrf — VRF Device
org.freedesktop.NetworkManager.Device.Vxlan — VXLAN Device
org.freedesktop.NetworkManager.Device.WifiP2P — Wi-Fi P2P Device
org.freedesktop.NetworkManager.Device.WireGuard — WireGuard Device
org.freedesktop.NetworkManager.Device.Wired — Wired Ethernet Device
org.freedesktop.NetworkManager.Device.Wireless — Wi-Fi Device
org.freedesktop.NetworkManager.Device.Wpan — IEEE 802.15.4 (WPAN) MAC Layer Device
org.freedesktop.NetworkManager.PPP — Helper interface for a PPP plugin
The /org/freedesktop/NetworkManager/ActiveConnection/* objects
org.freedesktop.NetworkManager.Connection.Active — Active Connection
org.freedesktop.NetworkManager.VPN.Connection — Active VPN Connection
The /org/freedesktop/NetworkManager/IP4Config/* objects
org.freedesktop.NetworkManager.IP4Config — IPv4 Configuration Set
The /org/freedesktop/NetworkManager/IP6Config/* objects
org.freedesktop.NetworkManager.IP6Config — IPv6 Configuration Set
The /org/freedesktop/NetworkManager/DHCP4Config/* objects
org.freedesktop.NetworkManager.DHCP4Config — IPv4 DHCP Client State
The /org/freedesktop/NetworkManager/DHCP4Config/* objects
org.freedesktop.NetworkManager.DHCP6Config — IPv6 DHCP Client State
The /org/freedesktop/NetworkManager/AccessPoint/* objects
org.freedesktop.NetworkManager.AccessPoint — Wi-Fi Access Point
The /org.freedesktop.NetworkManager.WifiP2PPeer/* objects
org.freedesktop.NetworkManager.WifiP2PPeer — Wi-Fi P2P Peer
The /org/freedesktop/NetworkManager/Checkpoint/* objects
org.freedesktop.NetworkManager.Checkpoint — Configuration and State Snapshot
NetworkManager D-Bus API Types
IV. Secret Agent D-Bus API Reference
Secret agents
org.freedesktop.NetworkManager.SecretAgent — User Secret Agent
V. VPN Plugin D-Bus API Reference
VPN services
org.freedesktop.NetworkManager.VPN.Plugin — VPN Service
VPN Plugin D-Bus API Types
A. License