From 494f296a3baab08522617b24b1f126d8f9a17502 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Wed, 20 Jan 2016 16:26:51 +0100 Subject: Imported Upstream version 1.1.90 --- docs/api/html/ref-settings.html | 452 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 431 insertions(+), 21 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 24add750..e3b8a8de 100644 --- a/docs/api/html/ref-settings.html +++ b/docs/api/html/ref-settings.html @@ -30,7 +30,7 @@ This part documents the properties and value types of each "Setting" object that composes the basic unit of NetworkManager configuration, the "Connection". Each Connection object is simply a dictionary mapping - setting names (like "wimax" or "bluetooth") to a dictionary of + setting names (like "802-3-ethernet" or "bluetooth") to a dictionary of key/value pairs that represents each itself.

@@ -451,6 +451,12 @@ The Spanning Tree Protocol (STP) maximum message age, in seconds. +
multicast-snooping
+
boolean
+
TRUE
+Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved. + + 
name
string
bridge
@@ -619,6 +625,12 @@ The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings). For software devices this specifies the name of the created device. For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface. +
lldp
+
int32
+
-1
+Whether LLDP is enabled for the connection. + + 
master
string

@@ -628,7 +640,7 @@
 
metered

 
NMMetered (int32)

 

-Whether the connection is metered.
+Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately.
 
 
 
name

@@ -682,7 +694,7 @@
 
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.
+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. When updating this property on a currently activated connection, the change takes effect immediately.
 
 
 

@@ -851,6 +863,12 @@
 The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network.  The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.
 
 
+
device-id

+
string

+

+The device unique identifier (as given by the WWAN management service) which this connection applies to.  If given, the connection will only apply to the specified device.
+
+
 
home-only

 
boolean

 
FALSE

@@ -899,6 +917,18 @@
 Flags indicating how to handle the "pin" property.
 
 
+
sim-id

+
string

+

+The SIM card unique identifier (as given by the WWAN management service) which this connection applies to.  If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.
+
+
+
sim-operator-id

+
string

+

+A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to.  If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioined by the given operator.
+
+
 
username

 
string

 

@@ -999,10 +1029,16 @@
 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-fqdn

+
string

+

+If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.
+
+
 
dhcp-hostname

 
string

 

-If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease.
+If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.
 
 
 
dhcp-send-hostname

@@ -1011,12 +1047,24 @@
 If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer.  If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.
 
 
+
dhcp-timeout

+
uint32

+
0

+A timeout for a DHCP transaction in seconds.
+
+
 
dns

 
array of uint32

 
[]

 Array of IP addresses of DNS servers (as network-byte-order integers)
 
 
+
dns-options

+
array of string

+
[]

+Array of DNS options. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties.
+
+
 
dns-search

 
array of string

 
[]

@@ -1103,6 +1151,12 @@
 
 
 
+
addr-gen-mode

+
int32

+
1

+Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: "eui64", "stable-privacy" or unset. If the property is set to "eui64", the addresses will be generated using the interface tokens derived from  hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced. The value of "stable-privacy" enables use of cryptographically secure hash of a secret host-specific key along with the connection identification and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced. Leaving this unset causes a default that could be subject to change in future versions to be used. Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.
+
+
 
address-data

 
array of vardict

 

@@ -1118,7 +1172,7 @@
 
dhcp-hostname

 
string

 

-If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease.
+If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.
 
 
 
dhcp-send-hostname

@@ -1133,6 +1187,12 @@
 Array of IP addresses of DNS servers (in network byte order)
 
 
+
dns-options

+
array of string

+
[]

+Array of DNS options. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties.
+
+
 
dns-search

 
array of string

 
[]

@@ -1160,7 +1220,7 @@
 
ip6-privacy

 
NMSettingIP6ConfigPrivacy (int32)

 

-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: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses). Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy". If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr".
+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: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses). Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy". If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr". Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.
 
 
 
may-fail

@@ -1209,7 +1269,155 @@
 
 


 

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

+
Table 15. ip-tunnel setting

+

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






Key NameValue TypeDefault ValueValue Description
encapsulation-limit
uint32
0
How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.
flow-label
uint32
0
The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.
input-key
string
The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.
local
string
The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.
mode
uint32
0
The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).
mtu
uint32
0
None
name
string
ip-tunnel
The setting's name, which uniquely identifies the setting within the connection.  Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".
output-key
string
The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.
parent
string
If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.
path-mtu-discovery
boolean
TRUE
Whether to enable Path MTU Discovery on this tunnel.
remote
string
The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.
tos
uint32
0
The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.
ttl
uint32
0
The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.

+

+


+

+
Table 16. macvlan setting

+

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






Key NameValue TypeDefault ValueValue Description
mode
uint32
0
The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.
name
string
macvlan
The setting's name, which uniquely identifies the setting within the connection.  Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".
parent
string
If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created.  If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.
promiscuous
boolean
TRUE
Whether the interface should be put in promiscuous mode.
tap
boolean
FALSE
Whether the interface should be a MACVTAP.

+

+


+

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

 
@@ -1253,7 +1461,7 @@
 


-
Table 16. ppp setting

+
Table 18. ppp setting

 

 
 

 
 
@@ -1387,7 +1595,7 @@
 


-
Table 17. pppoe setting

+
Table 19. pppoe setting

 

 
 

 
 
@@ -1437,7 +1645,7 @@
 


-
Table 18. serial setting

+
Table 20. serial setting

 

 
 

 
 
@@ -1493,7 +1701,7 @@
 


-
Table 19. team setting

+
Table 21. team setting

 

 
 

 
 
@@ -1531,7 +1739,7 @@
 


-
Table 20. team-port setting

+
Table 22. team-port setting

 

 
 

 
 
@@ -1563,7 +1771,69 @@
 


-
Table 21. vlan setting

+
Table 23. tun setting

+

 
 

 
 

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






Key NameValue TypeDefault ValueValue Description
group
string
The group ID which will own the device. If set to NULL everyone will be able to use the device.
mode
uint32
1
The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.
multi-queue
boolean
FALSE
If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.
name
string
tun
The setting's name, which uniquely identifies the setting within the connection.  Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".
owner
string
The user ID which will own the device. If set to NULL everyone will be able to use the device.
pi
boolean
FALSE
If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.
vnet-hdr
boolean
FALSE
If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.

+

+


+

+
Table 24. vlan setting

 
@@ -1588,7 +1858,7 @@
 
-
+
@@ -1625,7 +1895,7 @@
 


-
Table 22. vpn setting

+
Table 25. vpn setting

 

 
 

flags

 
NMVlanFlags (uint32)

 
One or more flags which control the behavior and features of the VLAN interface.  Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state).One or more flags which control the behavior and features of the VLAN interface.  Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol). The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.
 

 

 
id

 
 
@@ -1671,6 +1941,12 @@
 
+
+
+
+
+
+
@@ -1681,7 +1957,129 @@
 


-
Table 23. wimax setting

+
Table 26. vxlan setting

+

 
 

D-Bus service name of the VPN plugin that this setting uses to connect to its network.  i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.
 

 
timeout
uint32
0
Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overriden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.

 
user-name

 
string

 

 
 

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






Key NameValue TypeDefault ValueValue Description
ageing
uint32
0
Specifies the lifetime in seconds of FDB entries learnt by the kernel.
destination-port
uint32
8472
Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.
id
uint32
0
Specifies the VXLAN Network Identifer (or VXLAN Segment Identifier) to use.
l2-miss
boolean
FALSE
Specifies whether netlink LL ADDR miss notifications are generated.
l3-miss
boolean
FALSE
Specifies whether netlink IP ADDR miss notifications are generated.
learning
boolean
TRUE
Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.
limit
uint32
0
Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.
local
string
If given, specifies the source IP address to use in outgoing packets.
name
string
vxlan
The setting's name, which uniquely identifies the setting within the connection.  Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".
parent
string
If given, specifies the parent interface name or parent connection UUID.
proxy
boolean
FALSE
Specifies whether ARP proxy is turned on.
remote
string
Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.
rsc
boolean
FALSE
Specifies whether route short circuit is turned on.
source-port-max
uint32
0
Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.
source-port-min
uint32
0
Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.
tos
uint32
0
Specifies the TOS value to use in outgoing packets.
ttl
uint32
0
Specifies the time-to-live value to use in outgoing packets.

+

+


+

+
Table 27. wimax setting

 
@@ -1700,7 +2098,7 @@
 
-
+
@@ -1712,14 +2110,14 @@
 
-
+

 
 

mac-address

 
byte array

 
If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing).If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing). Deprecated: 1
 

 

 
name
network-name

 
string

 
Network Service Provider (NSP) name of the WiMAX network this connection should use.Network Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1
 

 
 

 

 


 

-
Table 24. 802-3-ethernet setting

+
Table 28. 802-3-ethernet setting

 
@@ -1823,7 +2221,7 @@
 


-
Table 25. 802-11-wireless setting

+
Table 29. 802-11-wireless setting

 

 
 

 
 
@@ -1881,6 +2279,12 @@
 
+
+
+
+
+
+
@@ -1899,6 +2303,12 @@
 
+
+
+
+
+
+
@@ -1933,7 +2343,7 @@
 


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

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

 

 
 

A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply.  Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").
 

 
mac-address-randomization
uint32
0
One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization),  NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address).

 
mode

 
string

 
The setting's name, which uniquely identifies the setting within the connection.  Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".
 

 
powersave
uint32
0
If set to FALSE, Wi-Fi power saving behavior is disabled.  If set to TRUE, Wi-Fi power saving behavior is enabled.  All other values are reserved.  Note that even though only boolean values are allowed, the property type is an unsigned integer to allow for future expansion.

 
rate

 
uint32

 
0

 
 
-- 
cgit 1.3.0-6-gf8a5