libnm Reference Manual: libnm Reference Manual

- for libnm 1.50.0 - - The latest version of this documentation can be found on-line at - https://networkmanager.dev/docs/libnm/latest/. -

- 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. -

Overview

Introduction to libnm
Using libnm

Client Object API Reference

-NMClient -
-NMSecretAgentOld -
-NMObject -
-nm-errors -
-nm-dbus-interface -
-nm-vpn-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 -
-NMSetting6Lowpan — Describes connection properties for 6LoWPAN interfaces -
-NMSetting8021x — Describes 802.1x-authenticated connection properties -
-NMSettingAdsl — Describes ADSL-based properties -
-NMSettingBluetooth — Describes Bluetooth connection properties -
-NMSettingBondPort — Describes connection properties for bond ports -
-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 -
-NMSettingEthtool — Describes connection properties for ethtool related options -
-NMSettingGeneric — Describes connection properties for generic devices -
-NMSettingGsm — Describes GSM/3GPP-based mobile broadband properties -
-NMSettingHostname — Contains properties related to the hostname -
-NMSettingHsr — Describes connection properties for HSR/PRP interfaces -
-NMSettingInfiniband — Describes connection properties for IP-over-InfiniBand networks -
-NMSettingIPConfig — Abstract base class for IPv4 and IPv6 -addressing, routing, and name service properties -
-NMSettingIPTunnel — Describes connection properties for IP tunnel devices -
-NMSettingIP4Config — Describes IPv4 addressing, routing, and name service properties -
-NMSettingIP6Config — Describes IPv6 addressing, routing, and name service properties -
-NMSettingLink — Contains properties related to the link -
-NMSettingLoopback — Describes connection properties for loopback interfaces -
-NMSettingMacsec — Describes connection properties for MACSEC interfaces -
-NMSettingMacvlan — Describes connection properties for macvlan interfaces -
-NMSettingMatch — Properties to match a connection with a device. -
-NMSettingOlpcMesh — Describes connection properties for OLPC-Mesh devices -
-NMSettingOvsBridge — Describes connection properties for Open vSwitch bridges. -
-NMSettingOvsDpdk — Describes connection properties for Open vSwitch DPDK interfaces. -
-NMSettingOvsExternalIDs — External-IDs for OVS database -
-NMSettingOvsInterface — Describes connection properties for Open vSwitch interfaces. -
-NMSettingOvsOtherConfig — Other-config settings for OVS -
-NMSettingOvsPatch — Describes connection properties for Open vSwitch patch interfaces. -
-NMSettingOvsPort — 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 -
-NMSettingSriov — Describes SR-IOV connection properties -
-NMSettingTCConfig — 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 -
-NMSettingUser — Describes user properties -
-NMSettingVeth — Describes connection properties for veth interfaces -
-NMSettingVlan — Describes connection properties for VLAN interfaces -
-NMSettingVpn — Describes connection properties for Virtual Private Networks -
-NMSettingVrf — Describes connection properties for vrf interfaces -
-NMSettingVxlan — Describes connection properties for VXLAN interfaces -
-NMSettingWifiP2P — 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 -
-NMSettingWireGuard — 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 -
-NMSettingWpan — Describes connection properties for IEEE 802.15.4 (WPAN) MAC -

Device and Runtime Configuration API Reference

-NMDevice -
-NMDevice6Lowpan -
-NMDeviceAdsl -
-NMDeviceBond -
-NMDeviceBridge -
-NMDeviceBt -
-NMDeviceDummy -
-NMDeviceEthernet -
-NMDeviceGeneric -
-NMDeviceHsr -
-NMDeviceInfiniband -
-NMDeviceIPTunnel -
-NMDeviceLoopback -
-NMDeviceMacsec -
-NMDeviceMacvlan -
-NMDeviceModem -
-NMDeviceOlpcMesh -
-NMDeviceOvsBridge -
-NMDeviceOvsInterface -
-NMDeviceOvsPort -
-NMDevicePpp -
-NMDeviceTeam -
-NMDeviceTun -
-NMDeviceVeth -
-NMDeviceVlan -
-NMDeviceVrf -
-NMDeviceVxlan -
-NMDeviceWifiP2P -
-NMDeviceWifi -
-NMDeviceWimax -
-NMDeviceWireGuard -
-NMDeviceWpan -
-NMActiveConnection -
-NMVpnConnection -
-NMAccessPoint -
-NMWifiP2PPeer -
-NMWimaxNsp -
-NMIPConfig -
-NMDhcpConfig -
-NMCheckpoint -

Utility API Reference

-nm-keyfile -
-nm-utils — Utility functions -
-nm-conn-utils — Connection utilities -
-nm-ethtool-utils -
-nm-version -
-nm-version-macros -

VPN Plugin API Reference

-NMVpnServicePlugin -
-NMVpnPluginInfo -
-NMVpnEditor -
-NMVpnEditorPlugin -
-NMVpnPluginOld -

Object Hierarchy

API Index

Annotation Glossary

A. License