From 9c202e3e860b3be9e1f8882630b69affbb130102 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sun, 3 Feb 2013 14:49:22 +0100 Subject: Imported Upstream version 0.9.7.995 --- docs/api/html/ref-settings.html | 247 +++++++++++++++++++++++++++++++++++----- 1 file changed, 221 insertions(+), 26 deletions(-) (limited to 'docs/api/html/ref-settings.html') diff --git a/docs/api/html/ref-settings.html b/docs/api/html/ref-settings.html index d87ab35c..8373c83b 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

@@ -246,7 +246,76 @@


-

Table 2. bluetooth setting

+

Table 2. adsl setting

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
name
string
adsl
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.
username
string
Username used to authenticate with the pppoa service.
password
string
Password used to authenticate with the pppoa service.
password-flags
uint32
0
Flags indicating how to handle the ADSL password. (see the section called “Secret flag types” for flag values)
protocol
string
ADSL connection protocol.
encapsulation
string
Encapsulation of ADSL connection
vpi
uint32
0
VPI of ADSL connection
vci
uint32
0
VCI of ADSL connection

+

+


+

+

+
Table 3. bluetooth setting

 
@@ -285,7 +354,7 @@
 


 

-
Table 3. bond setting

+
Table 4. bond setting

 

 
 

 
@@ -324,7 +393,121 @@
 


 

-
Table 4. cdma setting

+
Table 5. bridge setting

+

 
 

 

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






Key NameValue TypeDefault ValueValue Description
name
string
bridge
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 bridging network interface
stp
boolean
TRUE
Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.
priority
uint32
128
Sets the Spanning Tree Protocol (STP) priority for this bridge.  Lower values are 'better'; the lowest priority bridge will be elected the root bridge.
forward-delay
uint32
15
The Spanning Tree Protocol (STP) forwarding delay, in seconds.
hello-time
uint32
2
The Spanning Tree Protocol (STP) hello time, in seconds.
max-age
uint32
20
The Spanning Tree Protocol (STP) maximum message age, in seconds.
ageing-time
uint32
300
The ethernet MAC address aging time, in seconds.

+

+


+

+

+
Table 6. bridge-port setting

+

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






Key NameValue TypeDefault ValueValue Description
name
string
bridge-port
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.
priority
uint32
32
The Spanning Tree Protocol (STP) priority of this bridge port
path-cost
uint32
100
The Spanning Tree Protocol (STP) port cost for destinations via this port.
hairpin-mode
boolean
FALSE
Enables or disabled 'hairpin mode' for the port, which allows frames to be sent back out through the port the frame was received on.

+

+


+

+

+
Table 7. cdma setting

 
@@ -375,7 +558,7 @@
 


 

-
Table 5. connection setting

+
Table 8. connection setting

 

 
 

 
@@ -456,13 +639,19 @@
 
+
+
+
+
+
+

 
 


 Setting name describing the type of slave this connection is (ie, 'bond') or NULL if this connection is not a slave.
 
secondaries
array of string
[]
List of connection UUIDs that should be activated when the base connection itself is activated.

 
 

 

 


 

 

-
Table 6. gsm setting

+
Table 9. gsm setting

 
@@ -523,7 +712,7 @@
 
-
+
@@ -555,7 +744,7 @@
 


 

-
Table 7. infiniband setting

+
Table 10. infiniband setting

 

 
 

network-type

 
int32

 
-1
Network preference to force the device to only use specific network technologies.  The permitted values are: -1: any, 0: 3G only, 1: GPRS/EDGE only, 2: prefer 3G, and 3: prefer 2G.  Note that not all devices allow network preference control.Network preference to force the device to only use specific network technologies.  The permitted values are: -1: any, 0: 3G only, 1: GPRS/EDGE only, 2: prefer 3G, 3: prefer 2G, 4: prefer 4G/LTE, 5: 4G/LTE only. Note that not all devices allow network preference control.
 

 

 
pin

 
@@ -600,7 +789,7 @@
 


 

-
Table 8. ipv4 setting

+
Table 11. ipv4 setting

 

 
 

 
@@ -631,7 +820,7 @@
 
-
+
@@ -667,7 +856,7 @@
 
-
+
@@ -699,7 +888,7 @@
 


 

-
Table 9. ipv6 setting

+
Table 12. ipv6 setting

 

 
 

dns

 
array of uint32

 
[]
List of DNS servers (network byte order). For the 'auto' method, these DNS servers are appended to those (if any) returned by automatic configuration.  DNS servers cannot be used with the 'shared', 'link-local', or 'disabled' methods as there is no usptream network.  In all other methods, these DNS servers are used as the only DNS servers for this connection.List of DNS servers (network byte order). For the 'auto' method, these DNS servers are appended to those (if any) returned by automatic configuration.  DNS servers cannot be used with the 'shared', 'link-local', or 'disabled' methods as there is no upstream network.  In all other methods, these DNS servers are used as the only DNS servers for this connection.
 

 

 
dns-search
dhcp-client-id

 
string

 
A string sent to the DHCP server to identify the local machine which the DHCP server may use to cusomize the DHCP lease and options.A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options.
 

 

 
dhcp-send-hostname

 
@@ -727,6 +916,12 @@
 
+
+
+
+
+
+
@@ -786,7 +981,7 @@
 


 

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

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

 

 
 

IPv6 configuration method.  If 'auto' is specified then the appropriate automatic method (PPP, router advertisement, etc) is used for the device and most other properties can be left unset.  To force the use of DHCP only, specify 'dhcp'; this method is only valid for ethernet-based hardware.  If 'link-local' is specified, then an IPv6 link-local address will be assigned to the interface.  If 'manual' is specified, static IP addressing is used and at least one IP address must be given in  the 'addresses' property.  If 'ignored' is specified, IPv6 configuration is not done. This property must be set.  NOTE: the 'shared' methodis not yet supported.
 

 
dhcp-hostname
string
The specified name will be sent to the DHCP server when acquiring a lease.

 
dns

 
array of byte array

 
[]

 
@@ -831,7 +1026,7 @@
 


 

-
Table 11. ppp setting

+
Table 14. ppp setting

 

 
 

 
@@ -966,7 +1161,7 @@
 


 

-
Table 12. pppoe setting

+
Table 15. pppoe setting

 

 
 

 
@@ -1017,7 +1212,7 @@
 


 

-
Table 13. serial setting

+
Table 16. serial setting

 

 
 

 
@@ -1074,7 +1269,7 @@
 


 

-
Table 14. vlan setting

+
Table 17. vlan setting

 

 
 

 
@@ -1137,7 +1332,7 @@
 


 

-
Table 15. vpn setting

+
Table 18. vpn setting

 

 
 

 
@@ -1188,7 +1383,7 @@
 


 

-
Table 16. wimax setting

+
Table 19. wimax setting

 

 
 

 
@@ -1227,7 +1422,7 @@
 


 

-
Table 17. 802-3-ethernet setting

+
Table 20. 802-3-ethernet setting

 

 
 

 
@@ -1320,7 +1515,7 @@
 


 

-
Table 18. 802-11-wireless setting

+
Table 21. 802-11-wireless setting

 

 
 

 
@@ -1351,7 +1546,7 @@
 
-
+
@@ -1411,7 +1606,7 @@
 
-
+
@@ -1431,7 +1626,7 @@
 


 

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

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

 

 
 

mode

 
string

 
WiFi network mode; one of 'infrastructure' or 'adhoc'.  If blank, infrastructure is assumed.WiFi network mode; one of 'infrastructure', 'adhoc' or 'ap'.  If blank, infrastructure is assumed.
 

 

 
band
seen-bssids

 
array of string

 
[]
A list of BSSIDs (each BSSID formatted as a MAC address like 00:11:22:33:44:55') that have been detected as part of the WiFI network. NetworkManager internally tracks previously seen BSSIDs so this property is no longer of much use.A list of BSSIDs (each BSSID formatted as a MAC address like 00:11:22:33:44:55') that have been detected as part of the WiFI network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BBSID list of NetworkManager. The changes you make to this property will not be preserved.
 

 

 
security

 
-- 
cgit 1.3.0-6-gf8a5