From de06e5715e780baade318f3490ac7a4c9ce84e32 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sat, 24 Mar 2012 01:37:02 +0100 Subject: Imported Upstream version 0.9.4.0 --- docs/api/html/NetworkManager.devhelp2 | 28 ++--- docs/api/html/index.html | 32 ++--- docs/api/html/ix01.html | 2 +- docs/api/html/ref-migrating.html | 72 +++++------ docs/api/html/ref-settings.html | 227 +++++++++++++++++++++++++++++++--- docs/api/html/spec.html | 111 +++++++++++++++-- 6 files changed, 380 insertions(+), 92 deletions(-) (limited to 'docs/api/html') diff --git a/docs/api/html/NetworkManager.devhelp2 b/docs/api/html/NetworkManager.devhelp2 index b611186d..ba5d51b3 100644 --- a/docs/api/html/NetworkManager.devhelp2 +++ b/docs/api/html/NetworkManager.devhelp2 @@ -4,23 +4,23 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + diff --git a/docs/api/html/index.html b/docs/api/html/index.html index d0f34722..2c9b8d1b 100644 --- a/docs/api/html/index.html +++ b/docs/api/html/index.html @@ -22,11 +22,11 @@     
  

-

Version 0.9.2.0 +

Version 0.9.4.0

Copyright © 2011 The NetworkManager Authors

-

+

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 @@ -61,25 +61,25 @@

D-Bus API Reference
Network Configuration Setting Specification
-
Configuration Settings
+
Configuration Settings
Secret flag types
Migrating from NetworkManager 0.8 to NetworkManager 0.9
-
Architecture and D-Bus API Changes in 0.9
+
Architecture and D-Bus API Changes in 0.9
-
Elimination of the User Settings Service
-
User Secret Agents
-
Settings Service Interface Changes
-
Connection Object Interface Changes
-
Permissions Methods Consolidation
-
AddConnection Returns Object Path of New Connection
-
Support for WiMAX Devices
-
New Device States
-
New Active Connection State
-
Consolidated Modem Devices
-
Secret Property Flags
-
Deprecated Methods Removed
+
Elimination of the User Settings Service
+
User Secret Agents
+
Settings Service Interface Changes
+
Connection Object Interface Changes
+
Permissions Methods Consolidation
+
AddConnection Returns Object Path of New Connection
+
Support for WiMAX Devices
+
New Device States
+
New Active Connection State
+
Consolidated Modem Devices
+
Secret Property Flags
+
Deprecated Methods Removed
Index
diff --git a/docs/api/html/ix01.html b/docs/api/html/ix01.html index 1a38a76c..5affd5c8 100644 --- a/docs/api/html/ix01.html +++ b/docs/api/html/ix01.html @@ -21,7 +21,7 @@

-Index

+Index
diff --git a/docs/api/html/ref-migrating.html b/docs/api/html/ref-migrating.html index abc58248..56c6f912 100644 --- a/docs/api/html/ref-migrating.html +++ b/docs/api/html/ref-migrating.html @@ -23,20 +23,20 @@

Migrating from NetworkManager 0.8 to NetworkManager 0.9

-
Architecture and D-Bus API Changes in 0.9
+
Architecture and D-Bus API Changes in 0.9
-
Elimination of the User Settings Service
-
User Secret Agents
-
Settings Service Interface Changes
-
Connection Object Interface Changes
-
Permissions Methods Consolidation
-
AddConnection Returns Object Path of New Connection
-
Support for WiMAX Devices
-
New Device States
-
New Active Connection State
-
Consolidated Modem Devices
-
Secret Property Flags
-
Deprecated Methods Removed
+
Elimination of the User Settings Service
+
User Secret Agents
+
Settings Service Interface Changes
+
Connection Object Interface Changes
+
Permissions Methods Consolidation
+
AddConnection Returns Object Path of New Connection
+
Support for WiMAX Devices
+
New Device States
+
New Active Connection State
+
Consolidated Modem Devices
+
Secret Property Flags
+
Deprecated Methods Removed

@@ -50,14 +50,14 @@

-Architecture and D-Bus API Changes in 0.9

+Architecture and D-Bus API Changes in 0.9

This section details the architectural and D-Bus API changes in NetworkManager 0.9.

-Elimination of the User Settings Service

+Elimination of the User Settings Service

Previously there were two "settings services", or D-Bus services that provided and saved network configuration information. NetworkManager @@ -103,7 +103,7 @@

-User Secret Agents

+User Secret Agents

Even with the elimination of the user settings service, in some cases it is still desirable to store secrets in the user's session and not in @@ -152,7 +152,7 @@

-Settings Service Interface Changes

+Settings Service Interface Changes

With the elimination of the user settings service, the old org.freedesktop.NetworkManagerUserSettings and @@ -160,7 +160,8 @@ service names are no longer used. Instead NetworkManager provides the settings service using its own D-Bus service name, org.freedesktop.NetworkManager. The object path of - the settings service remains unchanged. + the settings service has also changed to + /org/freedesktop/NetworkManager/Settings.

Additionally, the D-Bus interface of the settings service has changed @@ -177,18 +178,19 @@ and CanModify properties.

- Action: change the service name that - your application uses to request system network settings to - org.freedesktop.NetworkManager, and update the D-Bus - interface that codes uses to talk to the settings service to - + Action: change the service name and + object path that your application uses to request system network settings + to org.freedesktop.NetworkManager and + /org/freedesktop/NetworkManager/Settings respectively, + and update the D-Bus interface that codes uses to talk to the settings + service to org.freedesktop.NetworkManager.Settings. Listen for hostname changes using the new interface name as well.

-Connection Object Interface Changes

+Connection Object Interface Changes

Consistent with the interface changes to the Settings object, the Connection object's D-Bus interface has changed to @@ -222,7 +224,7 @@

-Permissions Methods Consolidation

+Permissions Methods Consolidation

Previously there were two D-Bus method calls to retrieve the list of operations that a user client could perform, and two signals notifying @@ -254,7 +256,7 @@ are now string-based permissions. The mapping is as follows:

-

Table 17. 

+

Table 20. 

@@ -305,7 +307,7 @@

-AddConnection Returns Object Path of New Connection

+AddConnection Returns Object Path of New Connection

The org.freedesktop.NetworkManager.Settings.AddConnection @@ -323,7 +325,7 @@

-Support for WiMAX Devices

+Support for WiMAX Devices

NetworkManager now supports Intel WiMAX mobile broadband devices. A corresponding device type (NM_DEVICE_TYPE_WIMAX) and @@ -346,7 +348,7 @@

-New Device States

+New Device States

A few new device states have been added, and all device states have been renumbered for flexibility. @@ -361,7 +363,7 @@

-New Active Connection State

+New Active Connection State

Along with the new device states, an additional @@ -377,7 +379,7 @@

-Consolidated Modem Devices

+Consolidated Modem Devices

Many new mobile broadband devices support multiple access families, like Qualcomm Gobi cards (CDMA/EVDO and GSM/UMTS), or multi-mode EVDO/LTE @@ -413,7 +415,7 @@

-Secret Property Flags

+Secret Property Flags

In the Connection object's configuration properties, each setting's secret properties (like WiFi passphrases, or public key passwords, etc) now has @@ -422,7 +424,7 @@ following values:

-

Table 18. 

+

Table 21. 

@@ -484,7 +486,7 @@

-Deprecated Methods Removed

+Deprecated Methods Removed

A few methods and signals of the org.freedesktop.NetworkManager interface deprecated in version 0.7 have been removed. All the @@ -494,7 +496,7 @@ their replacements:

-

Table 19. 

+

Table 22. 

diff --git a/docs/api/html/ref-settings.html b/docs/api/html/ref-settings.html index b1737585..7278b958 100644 --- a/docs/api/html/ref-settings.html +++ b/docs/api/html/ref-settings.html @@ -23,7 +23,7 @@

Network Configuration Setting Specification

-
Configuration Settings
+
Configuration Settings
Secret flag types

@@ -35,11 +35,11 @@

-Configuration Settings

+Configuration Settings

-

Table 1. 802-1x setting

+

Table 1. 802-1x setting

@@ -79,6 +79,12 @@ + + + + + + @@ -181,6 +187,18 @@ + + + + + + + + + + + + @@ -228,7 +246,7 @@


-

Table 2. bluetooth setting

+

Table 2. bluetooth setting

Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS. 
pac-file
string
UTF-8 encoded file path containing PAC for EAP-FAST.

 
ca-cert

 
byte array

 
[]
Flags indicating how to handle the 802.1x password. (see the section called “Secret flag types” for flag values)
 

 
password-raw
byte array
[]
Password used for EAP authentication methods as a byte array
password-raw-flags
uint32
0
Flags indicating how to handle the 802.1x password byte array. (see the section called “Secret flag types” for flag values)

 
private-key

 
byte array

 
[]

 
@@ -267,7 +285,46 @@
 


 

-
Table 3. cdma setting

+
Table 3. bond setting

+

 
 

 

++++++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+






Key NameValue TypeDefault ValueValue Description
name
string
bond
The setting's name; these names are defined by the specification and cannot be changed after the object has been created.  Each setting class has a name, and all objects of that class share the same name.
interface-name
string
The name of the virtual in-kernel bonding network interface
options
dict of (string::string)
[ ]
Dictionary of key/value pairs of bonding options.  Both keys and values must be strings.  Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).

+

+


+

+

+
Table 4. cdma setting

 
@@ -318,7 +375,7 @@
 


 

-
Table 4. connection setting

+
Table 5. connection setting

 

 
 

 
@@ -381,13 +438,31 @@
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

 
 

FALSE

 If TRUE, the connection is read-only and cannot be changed by the user or any other mechanism.  This is normally set for system connections whose plugin cannot yet write updated connections back out.
 
zone
string
The trust level of a the connection.Free form case-insensitive string (for example "Home", "Work", "Public").  NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall.
master
string
Interface name of the master device or UUID of the master connection
slave-type
string
Setting name describing the type of slave this connection is (ie, 'bond') or NULL if this connection is not a slave.

 
 

 

 


 

 

-
Table 5. gsm setting

+
Table 6. gsm setting

 
@@ -480,7 +555,52 @@
 


 

-
Table 6. ipv4 setting

+
Table 7. infiniband setting

+

 
 

 

++++++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+






Key NameValue TypeDefault ValueValue Description
name
string
infiniband
The setting's name; these names are defined by the specification and cannot be changed after the object has been created.  Each setting class has a name, and all objects of that class share the same name.
mac-address
byte array
[]
If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches.  This property does not change the MAC address of the device (i.e. MAC spoofing).
mtu
uint32
0
If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.
transport-mode
string
The IPoIB transport mode. Either 'datagram' or 'connected'.

+

+


+

+

+
Table 8. ipv4 setting

 
@@ -570,7 +690,7 @@
 
-
+
@@ -579,7 +699,7 @@
 


 

-
Table 7. ipv6 setting

+
Table 9. ipv6 setting

 

 
 


 
may-fail

 
boolean
FALSE
TRUE

 If TRUE, allow overall network configuration to proceed even if IPv4 configuration times out. Note that at least one IP configuration must succeed or overall network configuration will still fail.  For example, in IPv6-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.
 

 
 
@@ -654,13 +774,19 @@
 
+
+
+
+
+
+

 
 

TRUE

 If TRUE, allow overall network configuration to proceed even if IPv6 configuration times out. Note that at least one IP configuration must succeed or overall network configuration will still fail.  For example, in IPv4-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv6 configuration fails but IPv4 configuration completes successfully.
 
ip6-privacy
int32
-1
Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941.  If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64.  This enhances privacy, but could cause problems in some applications, on the other hand.  The permitted values are: 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).

 
 

 

 


 

 

-
Table 8. 802-11-olpc-mesh setting

+
Table 10. 802-11-olpc-mesh setting

 
@@ -705,7 +831,7 @@
 


 

-
Table 9. ppp setting

+
Table 11. ppp setting

 

 
 

 
@@ -840,7 +966,7 @@
 


 

-
Table 10. pppoe setting

+
Table 12. pppoe setting

 

 
 

 
@@ -891,7 +1017,7 @@
 


 

-
Table 11. serial setting

+
Table 13. serial setting

 

 
 

 
@@ -948,7 +1074,70 @@
 


 

-
Table 12. vpn setting

+
Table 14. vlan setting

+

 
 

 

++++++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+






Key NameValue TypeDefault ValueValue Description
name
string
vlan
The setting's name; these names are defined by the specification and cannot be changed after the object has been created.  Each setting class has a name, and all objects of that class share the same name.
interface-name
string
If given, specifies the kernel name of the VLAN interface. If not given, a default name will be constructed from the interface described by the parent interface and the 'id' property, ex 'eth2.1'. The parent interface may be given by the 'parent' property or by a hardware address property, eg the 'wired' or 'infiniband' settings' 'mac-address' property.
parent
string
If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created.  If this property is not specified, the connection must contain a hardware address in a hardware-specific setting, like the 'wired' or 'infiniband' settings' 'mac-address' property.
id
uint32
0
The VLAN indentifier the interface created by this connection should be assigned.
flags
uint32
0
One or more flags which control the behavior and features of the VLAN interface.  Flags include reordering of output packet headers (0x01), use of the GVRP protocol (0x02), and loose binding of the interface to its master device's operating state (0x04).
ingress-priority-map
array of string
[]
For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities.  The mapping is given in the format 'from:to' where both 'from' and 'to' are unsigned integers, ie '7:3'.
egress-priority-map
array of string
[]
For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities.  The mapping is given in the format 'from:to' where both 'from' and 'to' are unsigned integers, ie '7:3'.

+

+


+

+

+
Table 15. vpn setting

 
@@ -999,7 +1188,7 @@
 


 

-
Table 13. wimax setting

+
Table 16. wimax setting

 

 
 

 
@@ -1038,7 +1227,7 @@
 


 

-
Table 14. 802-3-ethernet setting

+
Table 17. 802-3-ethernet setting

 

 
 

 
@@ -1131,7 +1320,7 @@
 


 

-
Table 15. 802-11-wireless setting

+
Table 18. 802-11-wireless setting

 

 
 

 
@@ -1236,7 +1425,7 @@
 


 

-
Table 16. 802-11-wireless-security setting

+
Table 19. 802-11-wireless-security setting

 

 
 

 
diff --git a/docs/api/html/spec.html b/docs/api/html/spec.html
index eb0a828b..a75799e7 100644
--- a/docs/api/html/spec.html
+++ b/docs/api/html/spec.html
@@ -1,5 +1,5 @@
 
-NetworkManager D-Bus Interface Specification version 0.9.2.0
NetworkManager D-Bus Interface Specification
Version 0.9.2.0
Copyright (C) 2008 - 2011 Red Hat, Inc.
Copyright (C) 2008 - 2009 Novell, Inc.

+        
NetworkManager D-Bus Interface Specification
Version 0.9.4.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
@@ -112,7 +112,7 @@ General Public License for more details.

 
You should have received a copy of the GNU Lesser General Public
 License along with this library; if not, write to the Free Software
 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

-
Interfaces

+
Interfaces
org.freedesktop.NetworkManager
Methods:
GetDevices (
         
         ) →
@@ -477,6 +477,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.NM_DEVICE_STATE)
     

         The current state of the device.
+      
StateReason -
+      (uu) -
+      (read)
+      (NM_DEVICE_STATE_REASON_STRUCT)
+    

+        The current state and reason for changing to that state.
       
ActiveConnection -
       o -
       (read)

@@ -559,6 +565,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
NM_DEVICE_TYPE_INFINIBAND = 9

+          The device is an IP-capable InfiniBand interface.
+        
NM_DEVICE_TYPE_BOND = 10

+          The device is a bond master interface.
+        
NM_DEVICE_TYPE_VLAN = 11

+          The device is a VLAN interface.
         
NM_DEVICE_STATE_REASON
NM_DEVICE_STATE_REASON_UNKNOWN = 0

           The reason for the device state change is unknown.
         
NM_DEVICE_STATE_REASON_NONE = 1

@@ -649,7 +661,33 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
NM_DEVICE_STATE_REASON_BT_FAILED = 44

           The Bluetooth connection timed out or failed.
-        
Sets of flags:
NM_DEVICE_CAP
NM_DEVICE_CAP_NONE = 0x0
Null capability.
NM_DEVICE_CAP_NM_SUPPORTED = 0x1
The device is supported by NetworkManager.
NM_DEVICE_CAP_CARRIER_DETECT = 0x2
The device supports carrier detection.

+        
NM_DEVICE_STATE_REASON_GSM_SIM_NOT_INSERTED = 45

+          GSM Modem's SIM Card not inserted.
+        
NM_DEVICE_STATE_REASON_GSM_SIM_PIN_REQUIRED = 46

+          GSM Modem's SIM Pin required.
+        
NM_DEVICE_STATE_REASON_GSM_SIM_PUK_REQUIRED = 47

+          GSM Modem's SIM Puk required.
+        
NM_DEVICE_STATE_REASON_GSM_SIM_WRONG = 48

+          GSM Modem's SIM wrong
+        
NM_DEVICE_STATE_REASON_INFINIBAND_MODE = 49

+          InfiniBand device does not support connected mode.
+        
NM_DEVICE_STATE_REASON_DEPENDENCY_FAILED = 50

+          A dependency of the connection failed.
+        
Sets of flags:
NM_DEVICE_CAP
NM_DEVICE_CAP_NONE = 0x0
Null capability.
NM_DEVICE_CAP_NM_SUPPORTED = 0x1
The device is supported by NetworkManager.
NM_DEVICE_CAP_CARRIER_DETECT = 0x2
The device supports carrier detection.
Structure types:
NM_DEVICE_STATE_REASON_STRUCT - (
+        u: state, u: reason
+        )
+      
Arrays of NM_DEVICE_STATE_REASON_STRUCT don't generally
+            make sense.
Members
state -
+      u
+      (NM_DEVICE_STATE)
+    

+          The device state.
+        
reason -
+      u
+      (NM_DEVICE_STATE_REASON)
+    

+          The reason for originally changing to the device state.
+        

 
   
org.freedesktop.NetworkManager.Device.Wired
Interface has no methods.
Signals:
PropertiesChanged (
         a{sv}: properties
@@ -897,6 +935,61 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
+  
org.freedesktop.NetworkManager.Device.Infiniband
Interface has no methods.
Signals:
PropertiesChanged (
+        a{sv}: properties
+        )
Parameters
properties -
+      a{sv}
+      (String_Variant_Map)
+    

+                A dictionary mapping property names to variant boxed values
+            
Properties:
HwAddress -
+      s -
+      (read)

+        Hardware address of the device.
+      
Carrier -
+      b -
+      (read)

+        Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
+      

+
+  
org.freedesktop.NetworkManager.Device.Bond
Interface has no methods.
Signals:
PropertiesChanged (
+        a{sv}: properties
+        )
Parameters
properties -
+      a{sv}
+      (String_Variant_Map)
+    

+                A dictionary mapping property names to variant boxed values
+            
Properties:
HwAddress -
+      s -
+      (read)

+        Hardware address of the device.
+      
Carrier -
+      b -
+      (read)

+        Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
+      

+
+  
org.freedesktop.NetworkManager.Device.Vlan
Interface has no methods.
Signals:
PropertiesChanged (
+        a{sv}: properties
+        )
Parameters
properties -
+      a{sv}
+      (String_Variant_Map)
+    

+                A dictionary mapping property names to variant boxed values
+            
Properties:
HwAddress -
+      s -
+      (read)

+        Hardware address of the device.
+      
Carrier -
+      b -
+      (read)

+        Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
+      
VlanId -
+      u -
+      (read)

+        The VLAN ID of this VLAN interface.
+      

+
   
org.freedesktop.NetworkManager.WiMax.Nsp
Interface has no methods.
Signals:
PropertiesChanged (
         a{sv}: properties
         )
Parameters
properties -
@@ -1135,7 +1228,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.b -
       (read)
Whether this active connection is the default IPv6 connection, i.e. whether it currently owns the default IPv6 route.
Vpn -
       b -
-      (read)
Whether this active connection is also a VPN connection.
Enumerated types:
NM_ACTIVE_CONNECTION_STATE
NM_ACTIVE_CONNECTION_STATE_UNKNOWN = 0

+      (read)
Whether this active connection is also a VPN connection.
Master -
+      o -
+      (read)
The path to the master device if the connection is a slave.
Enumerated types:
NM_ACTIVE_CONNECTION_STATE
NM_ACTIVE_CONNECTION_STATE_UNKNOWN = 0

           The active connection is in an unknown state.
         
NM_ACTIVE_CONNECTION_STATE_ACTIVATING = 1

           The connection is activating.
@@ -1502,7 +1597,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.org.freedesktop.NetworkManager.VPN.Error.BadArgumentsInvalid arguments were passed with the request.  FIXME: too general.
   
org.freedesktop.NetworkManager.VPN.Error.LaunchFailed
A binary providing the service failed to launch.
   
org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid
The request could not be processed because the VPN connection settings were invalid.
-
Index
Index of interfaces
Index of types