From 58f8be580039b0575b197b9573a1c92745d96d30 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 17 Jan 2017 20:25:09 +0100 Subject: New upstream version 1.5.90 --- docs/api/html/ref-settings.html | 190 +++++++++++++++++++++++++++++++++------- 1 file changed, 160 insertions(+), 30 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 a9046e2b..ceb81fd4 100644 --- a/docs/api/html/ref-settings.html +++ b/docs/api/html/ref-settings.html @@ -613,6 +613,12 @@ The autoconnect priority. If the connection is set to autoconnect, connections with higher priority will be preferred. Defaults to 0. The higher number means higher priority. +
autoconnect-retries
+
int32
+
-1
+The number of times a connection should be tried when autoctivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). + + 
autoconnect-slaves
NMSettingConnectionAutoconnectSlaves (int32)

@@ -688,7 +694,7 @@
 
stable-id

 
string

 

-This token to generate stable IDs for the connection. If unset, the UUID will be used instead. The stable-id is used instead of the connection UUID for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable.
+Token to generate stable IDs for the connection. The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. Note that also the interface name of the activating connection and a per-host secret key is included into the address generation so that the same stable-id on different hosts/devices yields different addresses. If the value is unset, an ID unique for the connection is used. Specifing a stable-id allows multiple connections to generate the same addresses. Another use is to generate IDs at runtime via dynamic substitutions. The '$' character is treated special to perform dynamic substitutions at runtime. Currently supported are "${CONNECTION}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-boot, or every time. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}/${BOOT}" to create a unique id for this connection that changes with every reboot. Note that two connections only use the same effective id if their stable-id is also identical before performing dynamic substitutions.
 
 
 
timestamp

@@ -1086,13 +1092,13 @@
 
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.
+Array of DNS options as described in man 5 resolv.conf. 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-priority

 
int32

 
0

-DNS priority. The relative priority to be used when determining the order of DNS servers in resolv.conf.  A lower value means that servers will be on top of the file.  Zero selects the default value, which is 50 for VPNs and 100 for other connections.  When multiple devices have configurations with the same priority, the one with an active default route will be preferred.  Note that when using dns=dnsmasq the order is meaningless since dnsmasq forwards queries to all known servers at the same time. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least a negative priority, only DNS servers from configurations with the lowest priority value will be used.
+Intra-connection DNS priority. The relative priority to be used when determining the order of DNS servers in resolv.conf.  A lower value means that servers will be on top of the file.  Zero selects the default value, which is 50 for VPNs and 100 for other connections.  Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. For that, just specify the DNS servers in the desired order. When multiple devices have configurations with the same priority, the one with an active default route will be preferred. Note that when using dns=dnsmasq the order is meaningless since dnsmasq forwards queries to all known servers at the same time. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least a negative priority, only DNS servers from connections with the lowest priority value will be used.
 
 
 
dns-search

@@ -1184,7 +1190,7 @@
 
addr-gen-mode

 
int32

 
1

-Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: "eui64", or "stable-privacy". 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. On D-Bus, the absence of an addr-gen-mode setting equals enabling "stable-privacy". For keyfile plugin, the absence of the setting on disk means "eui64" so that the property doesn't change on upgrade from older versions. 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.
+Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: "eui64", or "stable-privacy". 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's stable-id 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. On D-Bus, the absence of an addr-gen-mode setting equals enabling "stable-privacy". For keyfile plugin, the absence of the setting on disk means "eui64" so that the property doesn't change on upgrade from older versions. 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

@@ -1232,13 +1238,13 @@
 
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.
+Array of DNS options as described in man 5 resolv.conf. 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-priority

 
int32

 
0

-DNS priority. The relative priority to be used when determining the order of DNS servers in resolv.conf.  A lower value means that servers will be on top of the file.  Zero selects the default value, which is 50 for VPNs and 100 for other connections.  When multiple devices have configurations with the same priority, the one with an active default route will be preferred.  Note that when using dns=dnsmasq the order is meaningless since dnsmasq forwards queries to all known servers at the same time. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least a negative priority, only DNS servers from configurations with the lowest priority value will be used.
+Intra-connection DNS priority. The relative priority to be used when determining the order of DNS servers in resolv.conf.  A lower value means that servers will be on top of the file.  Zero selects the default value, which is 50 for VPNs and 100 for other connections.  Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. For that, just specify the DNS servers in the desired order. When multiple devices have configurations with the same priority, the one with an active default route will be preferred. Note that when using dns=dnsmasq the order is meaningless since dnsmasq forwards queries to all known servers at the same time. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least a negative priority, only DNS servers from connections with the lowest priority value will be used.
 
 
 
dns-search

@@ -1421,7 +1427,81 @@
 
 


 

-
Table 96. macvlan setting

+
Table 96. macsec setting

+

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






Key NameValue TypeDefault ValueValue Description
encrypt
boolean
TRUE
Whether the transmitted traffic must be encrypted.
mka-cak
string
The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement.
mka-cak-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "mka-cak" property.
mka-ckn
string
The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement.
mode
int32
0
Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.
name
string
macsec
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 MACSEC interface should be created.  If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.
port
int32
1
The port component of the SCI (Secure Channel Identifier), between 1 and 65534.
validation
int32
2
Specifies the validation mode for incoming frames.

+

+


+

+
Table 97. macvlan setting

 
@@ -1471,7 +1551,7 @@
 


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

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

 

 
 

 
 
@@ -1515,7 +1595,7 @@
 


-
Table 98. ppp setting

+
Table 99. ppp setting

 

 
 

 
 
@@ -1649,7 +1729,7 @@
 


-
Table 99. pppoe setting

+
Table 100. pppoe setting

 

 
 

 
 
@@ -1699,7 +1779,57 @@
 


-
Table 100. serial setting

+
Table 101. proxy setting

+

 
 

 
 

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






Key NameValue TypeDefault ValueValue Description
browser-only
boolean
FALSE
Whether the proxy configuration is for browser only.
method
int32
0
Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)
name
string
proxy
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".
pac-script
string
PAC script for the connection.
pac-url
string
PAC URL for obtaining PAC file.

+

+


+

+
Table 102. serial setting

 
@@ -1755,7 +1885,7 @@
 


-
Table 101. team setting

+
Table 103. team setting

 

 
 

 
 
@@ -1793,7 +1923,7 @@
 


-
Table 102. team-port setting

+
Table 104. team-port setting

 

 
 

 
 
@@ -1825,7 +1955,7 @@
 


-
Table 103. tun setting

+
Table 105. tun setting

 

 
 

 
 
@@ -1887,7 +2017,7 @@
 


-
Table 104. vlan setting

+
Table 106. vlan setting

 

 
 

 
 
@@ -1949,7 +2079,7 @@
 


-
Table 105. vpn setting

+
Table 107. vpn setting

 

 
 

 
 
@@ -2011,7 +2141,7 @@
 


-
Table 106. vxlan setting

+
Table 108. vxlan setting

 

 
 

 
 
@@ -2133,7 +2263,7 @@
 


-
Table 107. wimax setting

+
Table 109. wimax setting

 

 
 

 
 
@@ -2171,7 +2301,7 @@
 


-
Table 108. 802-3-ethernet setting

+
Table 110. 802-3-ethernet setting

 

 
 

 
 
@@ -2190,25 +2320,25 @@
 
-
+
-
-
+
+
-
+
-
+
@@ -2268,7 +2398,7 @@
 
-
+
@@ -2287,7 +2417,7 @@
 


-
Table 109. 802-11-wireless setting

+
Table 111. 802-11-wireless setting

 

 
 

assigned-mac-address

 
string

 
The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explict hardware addresses.The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explict hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".
 

 

 
auto-negotiate

 
boolean
TRUE
If TRUE, allow auto-negotiation of port speed and duplex mode.  If FALSE, do not allow auto-negotiation, in which case the "speed" and "duplex" properties should be set.
FALSE
If TRUE, enforce auto-negotiation of port speed and duplex mode.  If FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped.
 

 

 
cloned-mac-address

 
byte array

 
This D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random".This D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". For libnm and nmcli, this field is called "cloned-mac-address".
 

 

 
duplex

 
string

 
If specified, request that the device only use the specified duplex mode. Either "half" or "full".Can be specified only when "auto-negotiate" is "off". In that case, statically configures the device to use that specified duplex mode, either "half" or "full". Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.
 

 

 
generate-mac-address-mask
speed

 
uint32

 
0
If non-zero, request that the device use only the specified speed.  In Mbit/s, ie 100 == 100Mbit/s.Can be set to a value grater than zero only when "auto-negotiate" is "off". In that case, statically configures the device to use that specified speed. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.
 

 

 
wake-on-lan

 
 
@@ -2306,7 +2436,7 @@
 
-
+
@@ -2330,7 +2460,7 @@
 
-
+
@@ -2360,7 +2490,7 @@
 
-
+
@@ -2421,7 +2551,7 @@
 


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

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

 

 
 

assigned-mac-address

 
string

 
The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explict hardware addresses.The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explict hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".
 

 

 
band
cloned-mac-address

 
byte array

 
This D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random".This D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". For libnm and nmcli, this field is called "cloned-mac-address".
 

 

 
generate-mac-address-mask
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). Deprecated: 1One 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). This property is deprecated for 'cloned-mac-address'. Deprecated: 1
 

 

 
mode

 
 
-- 
cgit 1.3.0-6-gf8a5