libnm Reference Manual: libnm Reference Manual

for libnm 1.16.0 The latest version of this documentation can be found on-line at https://developer.gnome.org/libnm/stable/.

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,
  Boston, MA 02110-1301,
  USA

Overview

Introduction to libnm
Using libnm

Client Object API Reference

NMClient
NMSecretAgentOld
NMObject
nm-errors
nm-dbus-interface

Connection and Setting API Reference

NMConnection — Describes a connection to specific network or provider
NMSimpleConnection — An unmanaged connection
NMRemoteConnection — A connection managed by NetworkManager server
NMSetting — Describes related configuration information
NMSettingConnection — Describes general connection properties
nm-setting-6lowpan — Describes connection properties for 6LoWPAN interfaces
NMSetting8021x — Describes 802.1x-authenticated connection properties
NMSettingAdsl — Describes ADSL-based properties
NMSettingBluetooth — Describes Bluetooth connection properties
NMSettingBond — Describes connection properties for bonds
NMSettingBridgePort — Describes connection properties for bridge ports
NMSettingBridge — Describes connection properties for bridges
NMSettingCdma — Describes CDMA-based mobile broadband properties
NMSettingDcb — Connection properties for Data Center Bridging
NMSettingDummy — Describes connection properties for dummy interfaces
nm-setting-ethtool — Describes connection properties for ethtool related options
NMSettingGeneric — Describes connection properties for generic devices
NMSettingGsm — Describes GSM/3GPP-based mobile broadband properties
NMSettingInfiniband — Describes connection properties for IP-over-InfiniBand networks
NMSettingIP4Config — Describes IPv4 addressing, routing, and name service properties
NMSettingIP6Config — Describes IPv6 addressing, routing, and name service properties
NMSettingIPConfig — Abstract base class for IPv4 and IPv6 addressing, routing, and name service properties
NMSettingIPTunnel — Describes connection properties for IP tunnel devices
NMSettingMacsec — Describes connection properties for MACSEC interfaces
NMSettingMacvlan — Describes connection properties for macvlan interfaces
nm-setting-match — Properties to match a connection with a device.
NMSettingOlpcMesh — Describes connection properties for OLPC-Mesh devices
nm-setting-ovs-bridge — Describes connection properties for Open vSwitch bridges.
nm-setting-ovs-interface — Describes connection properties for Open vSwitch interfaces.
nm-setting-ovs-patch — Describes connection properties for Open vSwitch patch interfaces.
nm-setting-ovs-port — Describes connection properties for Open vSwitch ports.
NMSettingPpp — Describes connection properties for devices/networks that require PPP to deliver IP capability
NMSettingPppoe — Describes PPPoE connection properties
NMSettingProxy — Describes proxy URL, script and other related properties
NMSettingSerial — Describes connection properties for devices that use serial communications
nm-setting-sriov — Describes SR-IOV connection properties
nm-setting-tc-config — Describes connection properties for the Linux Traffic Control
NMSettingTeamPort — Describes connection properties for team ports
NMSettingTeam — Describes connection properties for teams
NMSettingTun — Describes connection properties for TUN/TAP interfaces
nm-setting-user — Describes user properties
NMSettingVlan — Describes connection properties for VLAN interfaces
NMSettingVpn — Describes connection properties for Virtual Private Networks
NMSettingVxlan — Describes connection properties for VXLAN interfaces
nm-setting-wifi-p2p — Describes connection properties for 802.11 Wi-Fi P2P networks
NMSettingWimax — Describes 802.16e Mobile WiMAX connection properties
NMSettingWired — Describes connection properties for Ethernet-based networks
nm-setting-wireguard — Describes connection properties for wireguard related options
NMSettingWirelessSecurity — Describes connection properties for Wi-Fi networks that use WEP, LEAP, WPA or WPA2/RSN security
NMSettingWireless — Describes connection properties for 802.11 Wi-Fi networks
nm-setting-wpan — Describes connection properties for IEEE 802.15.4 (WPAN) MAC

Device and Runtime Configuration API Reference

NMDevice
nm-device-6lowpan
NMDeviceAdsl
NMDeviceBond
NMDeviceBridge
NMDeviceBt
NMDeviceDummy
NMDeviceEthernet
NMDeviceGeneric
NMDeviceInfiniband
NMDeviceIPTunnel
NMDeviceMacsec
NMDeviceMacvlan
NMDeviceModem
NMDeviceOlpcMesh
nm-device-ovs-bridge
nm-device-ovs-interface
nm-device-ovs-port
nm-device-ppp
NMDeviceTeam
NMDeviceTun
NMDeviceVlan
NMDeviceVxlan
nm-device-wifi-p2p
NMDeviceWifi
NMDeviceWimax
nm-device-wireguard
nm-device-wpan
NMActiveConnection
NMVpnConnection
NMAccessPoint
nm-wifi-p2p-peer
NMWimaxNsp
NMIPConfig
NMDhcpConfig
nm-checkpoint

Utility API Reference

nm-utils — Utility functions
nm-version

VPN Plugin API Reference

nm-vpn-service-plugin
nm-vpn-plugin-info
NMVpnEditor
NMVpnEditorPlugin
nm-vpn-plugin-old

Object Hierarchy

API Index

Annotation Glossary