From 2c032d8f1c6292c1338a615e6ec40252889ba85c Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Thu, 22 Jan 2015 00:29:39 +0100 Subject: Imported Upstream version 1.0.0 --- docs/api/html/spec.html | 140 ++++++++++++++++++++++++++++++++++++------------ 1 file changed, 105 insertions(+), 35 deletions(-) (limited to 'docs/api/html/spec.html') diff --git a/docs/api/html/spec.html b/docs/api/html/spec.html index 84819cab..cf717b59 100644 --- a/docs/api/html/spec.html +++ b/docs/api/html/spec.html @@ -1,4 +1,4 @@ -NetworkManager D-Bus Interface Specification version 0.9.10.0

NetworkManager D-Bus Interface Specification

Version 0.9.10.0

Copyright (C) 2008 - 2011 Red Hat, Inc.
Copyright (C) 2008 - 2009 Novell, Inc.
+

NetworkManager D-Bus Interface Specification

Version 1.0.0

Copyright (C) 2008 - 2011 Red Hat, Inc.
Copyright (C) 2008 - 2009 Novell, Inc.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or @@ -162,11 +162,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Returns

active_connection - o
The path of the active connection object representing this active connection. -

Possible errors

org.freedesktop.NetworkManager.Error.UnknownConnection
- Connection was not provided by the settings service. - (generic description)
org.freedesktop.NetworkManager.Error.UnknownDevice
- Unknown device. - (generic description)
org.freedesktop.NetworkManager.Error.ConnectionActivating
Another connection is already activating or the same connection is already active. FIXME: check if the error name is correct. FIXME: split into 2 errors?
org.freedesktop.NetworkManager.Error.ConnectionInvalid
The connection is invalid for this device.

AddAndActivateConnection ( +

AddAndActivateConnection ( a{sa{sv}}: connection, o: device, o: specific_object ) → o, o

@@ -195,11 +191,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
active_connection - o
The path of the active connection object representing this active connection. -

Possible errors

org.freedesktop.NetworkManager.Error.UnknownConnection
- Connection was not provided by the settings service. - (generic description)
org.freedesktop.NetworkManager.Error.UnknownDevice
- Unknown device. - (generic description)
org.freedesktop.NetworkManager.Error.ConnectionInvalid
The connection is invalid for this device.

DeactivateConnection ( +

DeactivateConnection ( o: active_connection ) → nothing

@@ -254,7 +246,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Parameters

level - s
- One of [ERR, WARN, INFO, DEBUG]. + One of [ERR, WARN, INFO, DEBUG, TRACE].
domains - s
A combination of logging domains separated by commas (','), or "NONE" @@ -277,7 +269,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Returns

level - s
- One of [ERR, WARN, INFO, DEBUG]. + One of [ERR, WARN, INFO, DEBUG, TRACE].
domains - s
For available domains see SetLogging() call. @@ -383,6 +375,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
PrimaryConnectionType - + s - + (read)
+ The connection type of the "primary" active connection being + used to access the network. This is the same as the Type + property on the object indicated by PrimaryConnection.
ActivatingConnection - o - (read)
@@ -491,6 +489,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Disconnects a device and prevents the device from automatically activating further connections without user intervention. +

Delete ( + + ) → + nothing

+ Deletes a software device from NetworkManager and removes the interface from the system. + The method returns an error when called for a hardware device.

Signals:

StateChanged ( u: new_state, u: old_state, u: reason )

Parameters

new_state - @@ -603,7 +607,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
FirmwareMissing - b - (read)
@@ -1212,6 +1217,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.b - (read)
Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). +
Parent - + o - + (read)
+ Object path of the parent device of this VLAN device.
VlanId - u - (read)
@@ -1257,19 +1266,39 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.String_Variant_Map)
A dictionary mapping property names to variant boxed values -

Properties:

Gateway - - s - - (read)
The gateway in use.
Addresses - +

Properties:

Addresses - aau - - (read)
Array of tuples of IPv4 address/prefix/gateway. All 3 - elements of each tuple are in network byte order. Essentially: - [(addr, prefix, gateway), (addr, prefix, gateway), ...] -
Routes - + (read)
+ Array of arrays of IPv4 address/prefix/gateway. All 3 + elements of each array are in network byte order. Essentially: + [(addr, prefix, gateway), (addr, prefix, gateway), ...] + + Deprecated: use AddressData and Gateway +
AddressData - + aa{sv} - + (read)
+ Array of IP address data objects. All addresses will include + "address" (an IP address string), and "prefix" (a uint). Some + addresses may include additional attributes. +
Gateway - + s - + (read)
The gateway in use.
Routes - aau - - (read)
Tuples of IPv4 route/prefix/next-hop/metric. All 4 elements - of each tuple are in network byte order. 'route' and 'next hop' are IPv4 - addresses, while prefix and metric are simple unsigned integers. Essentially: - [(route, prefix, next-hop, metric), (route, prefix, next-hop, metric), ...] + (read)
+ Arrays of IPv4 route/prefix/next-hop/metric. All 4 elements of + each tuple are in network byte order. 'route' and 'next hop' + are IPv4 addresses, while prefix and metric are simple + unsigned integers. Essentially: [(route, prefix, next-hop, + metric), (route, prefix, next-hop, metric), ...] + + Deprecated: use RouteData +
RouteData - + aa{sv} - + (read)
+ Array of IP route data objects. All routes will include "dest" + (an IP address string) and "prefix" (a uint). Some routes may + include "next-hop" (an IP address string), "metric" (a uint), + and additional attributes.
Nameservers - au - (read)
The nameservers in use.
Domains - @@ -1287,13 +1316,34 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.String_Variant_Map)
A dictionary mapping property names to variant boxed values -

Properties:

Gateway - - s - - (read)
The gateway in use.
Addresses - +

Properties:

Addresses - a(ayuay) - - (read)
Tuples of IPv6 address/prefix/gateway.
Routes - + (read)
+ Array of tuples of IPv6 address/prefix/gateway. + + Deprecated: use AddressData and Gateway. +
AddressData - + aa{sv} - + (read)
+ Array of IP address data objects. All addresses will include + "address" (an IP address string), and "prefix" (a uint). Some + addresses may include additional attributes. +
Gateway - + s - + (read)
The gateway in use.
Routes - a(ayuayu) - - (read)
Tuples of IPv6 route/prefix/next-hop/metric.
Nameservers - + (read)
+ Tuples of IPv6 route/prefix/next-hop/metric. + + Deprecated: use RouteData +
RouteData - + aa{sv} - + (read)
+ Array of IP route data objects. All routes will include "dest" + (an IP address string) and "prefix" (a uint). Some routes may + include "next-hop" (an IP address string), "metric" (a uint), + and additional attributes. +
Nameservers - aay - (read)
The nameservers in use.
Domains - as - @@ -1539,7 +1589,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.String_String_Variant_Map_Map)
Nested settings maps containing secrets. -

Save ( +

ClearSecrets ( + + ) → + nothing

+ Clear the secrets belonging to this network connection profile. +

Save ( ) → nothing

@@ -2117,7 +2172,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Parameters

state - u - (NM_VPN_CONNECTION_STATE) + (NM_VPN_SERVICE_STATE)
The new state of the plugin.

SecretsRequired ( @@ -2183,10 +2238,24 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Properties:

State - u - (read) - (NM_VPN_CONNECTION_STATE) + (NM_VPN_SERVICE_STATE)
The state of the plugin. -

Enumerated types:

NM_VPN_PLUGIN_FAILURE

NM_VPN_PLUGIN_FAILURE_LOGIN_FAILED = 0
+

Enumerated types:

NM_VPN_SERVICE_STATE

NM_VPN_SERVICE_STATE_UNKNOWN = 0
+ The state of the VPN plugin is unknown. +
NM_VPN_SERVICE_STATE_INIT = 1
+ The VPN plugin is initialized. +
NM_VPN_SERVICE_STATE_SHUTDOWN = 2
+ (Not used.) +
NM_VPN_SERVICE_STATE_STARTING = 3
+ The plugin is attempting to connect to a VPN server. +
NM_VPN_SERVICE_STATE_STARTED = 4
+ The plugin has connected to a VPN server. +
NM_VPN_SERVICE_STATE_STOPPING = 5
+ The plugin is disconnecting from the VPN server. +
NM_VPN_SERVICE_STATE_STOPPED = 6
+ The plugin has disconnected from the VPN server. +

NM_VPN_PLUGIN_FAILURE

NM_VPN_PLUGIN_FAILURE_LOGIN_FAILED = 0
Login failed.
NM_VPN_PLUGIN_FAILURE_CONNECT_FAILED = 1
Connect failed. @@ -2295,6 +2364,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  • NM_VPN_CONNECTION_STATE - u
  • NM_VPN_CONNECTION_STATE_REASON - u
  • NM_VPN_PLUGIN_FAILURE + - u
  • NM_VPN_SERVICE_STATE - u
  • NM_WIMAX_NSP_NETWORK_TYPE - u
  • String_String_Map - a{ s → s } -- cgit 1.3.0-6-gf8a5