From c333f062ddcba9b35330647bf6cbd0a07f2d786e Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Thu, 11 May 2017 14:55:55 +0200 Subject: New upstream version 1.8.0 --- docs/api/html/index.html | 266 +++++++++++++++++++++++++++++++++++++---------- 1 file changed, 209 insertions(+), 57 deletions(-) (limited to 'docs/api/html/index.html') diff --git a/docs/api/html/index.html b/docs/api/html/index.html index 31b20cb5..59c9f18a 100644 --- a/docs/api/html/index.html +++ b/docs/api/html/index.html @@ -4,8 +4,9 @@ NetworkManager Reference Manual: NetworkManager Reference Manual + - + @@ -14,9 +15,13 @@
-

Version 1.6.2 -

-
+

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

+

Permission is granted to copy, distribute and/or modify this @@ -39,23 +44,46 @@

+
+

Abstract

+

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

+

-
Manual Pages
+
I. Manual Pages
-nmcli — command-line tool for controlling NetworkManager +NetworkManager — network management daemon
-nmtui — Text User Interface for controlling NetworkManager +NetworkManager.conf — NetworkManager configuration file
-nm-online — ask NetworkManager whether the network is connected +nmcli — command-line tool for controlling NetworkManager
-NetworkManager.conf — NetworkManager configuration file +nmcli-examples — usage examples of nmcli +
+
+nmtui — Text User Interface for controlling NetworkManager
nm-settings — Description of settings and properties of NetworkManager connection profiles @@ -67,139 +95,263 @@ nm-settings-ifcfg-rh — Description of ifcfg-rh settings plugin
-nmcli-examples — usage examples of nmcli -
-
-NetworkManager — network management daemon +nm-online — ask NetworkManager whether the network is connected
-
D-Bus API Reference
+
II. Network Configuration Setting Specification
-
Interfaces
+
Configuration Settings
-org.freedesktop.NetworkManager +connection — General Connection Profile Settings +
+
+802-1x — AIEEE 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
-org.freedesktop.NetworkManager.Settings +dcb — Data Center Bridging Settings
-org.freedesktop.NetworkManager.AgentManager +dummy — Dummy Link Settings
-org.freedesktop.NetworkManager.AccessPoint +generic — Generic Link Settings
-org.freedesktop.NetworkManager.PPP +gsm — GSM-based Mobile Broadband Settings
-org.freedesktop.NetworkManager.Settings.Connection +infiniband — Infiniband Settings
-org.freedesktop.NetworkManager.VPN.Connection +ipv4 — IPv4 Settings
-org.freedesktop.NetworkManager.Connection.Active +ipv6 — IPv6 Settings
-org.freedesktop.NetworkManager.Device +ip-tunnel — IP Tunneling Settings
-org.freedesktop.NetworkManager.Device.Adsl +macsec — MACSec Settings
-org.freedesktop.NetworkManager.Device.Bond +macvlan — MAC VLAN Settings
-org.freedesktop.NetworkManager.Device.Bridge +802-11-olpc-mesh — OLPC Wireless Mesh Settings
-org.freedesktop.NetworkManager.Device.Bluetooth +ppp — Point-to-Point Protocol Settings
-org.freedesktop.NetworkManager.Device.Wired +pppoe — PPP-over-Ethernet Settings
-org.freedesktop.NetworkManager.Device.Generic +proxy — WWW Proxy Settings
-org.freedesktop.NetworkManager.Device.Infiniband +serial — Serial Link Settings
-org.freedesktop.NetworkManager.Device.IPTunnel +team — Teaming Settings
-org.freedesktop.NetworkManager.Device.Macsec +team-port — Team Port Settings
-org.freedesktop.NetworkManager.Device.Macvlan +tun — Tunnel Settings
-org.freedesktop.NetworkManager.Device.Modem +user — General User Profile Settings
-org.freedesktop.NetworkManager.Device.OlpcMesh +vlan — VLAN Settings
-org.freedesktop.NetworkManager.Device.Team +vpn — VPN Settings
-org.freedesktop.NetworkManager.Device.Tun +vxlan — VXLAN Settings
-org.freedesktop.NetworkManager.Device.Veth +wimax — WiMax Settings
-org.freedesktop.NetworkManager.Device.Vlan +802-3-ethernet — Wired Ethernet Settings
-org.freedesktop.NetworkManager.Device.Vxlan +802-11-wireless — Wi-Fi Settings
-org.freedesktop.NetworkManager.Device.Wireless +802-11-wireless-security — Wi-Fi Security 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.Bond — Bonding Device +
+
+org.freedesktop.NetworkManager.Device.Bridge — Bridging Device +
+
+org.freedesktop.NetworkManager.Device.Bluetooth — Bluetooth Device +
+
+org.freedesktop.NetworkManager.Device.Dummy — Dummy Device +
+
+org.freedesktop.NetworkManager.Device.Wired — Wired Ethernet Device +
+
+org.freedesktop.NetworkManager.Device.Generic — Unrecognized Device +
+
+org.freedesktop.NetworkManager.Device.Infiniband — Infiniband Device
-org.freedesktop.NetworkManager.Device.WiMax +org.freedesktop.NetworkManager.Device.IPTunnel — IP Tunneling Device
-org.freedesktop.NetworkManager.DHCP4Config +org.freedesktop.NetworkManager.Device.Macsec — MACSec Device
-org.freedesktop.NetworkManager.DHCP6Config +org.freedesktop.NetworkManager.Device.Macvlan — MAC VLAN Device
-org.freedesktop.NetworkManager.IP4Config +org.freedesktop.NetworkManager.Device.Modem — Modem Device
-org.freedesktop.NetworkManager.IP6Config +org.freedesktop.NetworkManager.Device.OlpcMesh — OLPC Wireless Mesh Device
-org.freedesktop.NetworkManager.VPN.Plugin +org.freedesktop.NetworkManager.Device.Team — Teaming Device
-org.freedesktop.NetworkManager.SecretAgent +org.freedesktop.NetworkManager.Device.Tun — Userspace Tunneling Device
-org.freedesktop.NetworkManager.Device.Statistics +org.freedesktop.NetworkManager.Device.Veth — Virtual Ethernet Device
-org.freedesktop.NetworkManager.DnsManager +org.freedesktop.NetworkManager.Device.Vlan — Virtual LAN Device +
+
+org.freedesktop.NetworkManager.Device.Vxlan — VXLAN Device +
+
+org.freedesktop.NetworkManager.Device.Wireless — Wi-Fi Device +
+
+org.freedesktop.NetworkManager.Device.WiMax — WiMax Device +
+
+org.freedesktop.NetworkManager.PPP — Helper interface for a PPP plugin
-
Types
+
The /org/freedesktop/NetworkManager/ActiveConnection/* objects
-NetworkManager D-Bus API Types +org.freedesktop.NetworkManager.Connection.Active — Active Connection
-VPN Plugin D-Bus API Types +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 +
+
Types
+
+NetworkManager D-Bus API Types +
+
+
IV. Secret Agent D-Bus API Reference
+
+
Secret agents
+
+org.freedesktop.NetworkManager.SecretAgent — User Secret Agent +
-
Network Configuration Setting Specification
+
V. VPN Plugin D-Bus API Reference
-
Configuration Settings
-
Secret flag types
+
VPN services
+
+org.freedesktop.NetworkManager.VPN.Plugin — VPN Service +
+
Types
+
+VPN Plugin D-Bus API Types +
Index
A. License
-- cgit 1.3.0-6-gf8a5