about summary refs log tree commit diff
path: root/docs/api/html/nm-settings.html
diff options
context:
space:
mode:
authorMichael Biebl <biebl@debian.org>2018-05-11 22:08:45 +0200
committerMichael Biebl <biebl@debian.org>2018-05-11 22:08:45 +0200
commitee9c73a923909e23a649407be77e25235d769e25 (patch)
treee21c923621fa278e737da693df9eb60ea31a6067 /docs/api/html/nm-settings.html
parentf60117b41d5433be1b4a96d82cd11d0c3dce9b63 (diff)
New upstream version 1.10.8 upstream/1.10.8
Diffstat (limited to 'docs/api/html/nm-settings.html')
-rw-r--r--docs/api/html/nm-settings.html51
1 files changed, 15 insertions, 36 deletions
diff --git a/docs/api/html/nm-settings.html b/docs/api/html/nm-settings.html
index 049563b2..ff0fe48f 100644
--- a/docs/api/html/nm-settings.html
+++ b/docs/api/html/nm-settings.html
@@ -122,7 +122,7 @@
 <a name="nm-settings.property.connection.autoconnect"></a>autoconnect</td>
 <td align="left">boolean</td>
 <td align="left">TRUE</td>
-<td>Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection. Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles.</td>
+<td>Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection.</td>
 </tr>
 <tr>
 <td align="left">
@@ -143,7 +143,7 @@
 <a name="nm-settings.property.connection.autoconnect-slaves"></a>autoconnect-slaves</td>
 <td align="left">NMSettingConnectionAutoconnectSlaves (int32)</td>
 <td align="left"> </td>
-<td>Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0.</td>
+<td>Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0.</td>
 </tr>
 <tr>
 <td align="left">
@@ -182,13 +182,6 @@
 </tr>
 <tr>
 <td align="left">
-<a name="nm-settings.property.connection.mdns"></a>mdns</td>
-<td align="left">int32</td>
-<td align="left">-1</td>
-<td>Whether mDNS is enabled for the connection. The permitted values are: yes: register hostname and resolving for the connection, no: disable mDNS for the interface, resolve: do not register hostname but allow resolving of mDNS host names. When updating this property on a currently activated connection, the change takes effect immediately. This feature requires a plugin which supports mDNS. One such plugin is dns-systemd-resolved.</td>
-</tr>
-<tr>
-<td align="left">
 <a name="nm-settings.property.connection.metered"></a>metered</td>
 <td align="left">NMMetered (int32)</td>
 <td align="left"> </td>
@@ -234,7 +227,7 @@
 <a name="nm-settings.property.connection.stable-id"></a>stable-id</td>
 <td align="left">string</td>
 <td align="left"> </td>
-<td>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. It is also used as DHCP client identifier with ipv4.dhcp-client-id=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. Specifying 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.</td>
+<td>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. Specifying 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.</td>
 </tr>
 <tr>
 <td align="left">
@@ -822,7 +815,7 @@
 <a name="nm-settings.property.bridge.mac-address"></a>mac-address</td>
 <td align="left">byte array</td>
 <td align="left"> </td>
-<td>If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge. Hence, this property is deprecated. Deprecated: 1</td>
+<td>If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge. Hence, this property is deprecated.</td>
 </tr>
 <tr>
 <td align="left">
@@ -1052,14 +1045,14 @@
 <td align="left">
 <a name="nm-settings.property.dcb.priority-bandwidth"></a>priority-bandwidth</td>
 <td align="left">array of uint32</td>
-<td align="left">[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L]</td>
+<td align="left">[0, 0, 0, 0, 0, 0, 0, 0]</td>
 <td>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use.  The sum of all percentages for priorities which belong to the same group must total 100 percents.</td>
 </tr>
 <tr>
 <td align="left">
 <a name="nm-settings.property.dcb.priority-flow-control"></a>priority-flow-control</td>
 <td align="left">array of uint32</td>
-<td align="left">[False, False, False, False, False, False, False, False]</td>
+<td align="left">[0, 0, 0, 0, 0, 0, 0, 0]</td>
 <td>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.</td>
 </tr>
 <tr>
@@ -1073,7 +1066,7 @@
 <td align="left">
 <a name="nm-settings.property.dcb.priority-group-bandwidth"></a>priority-group-bandwidth</td>
 <td align="left">array of uint32</td>
-<td align="left">[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L]</td>
+<td align="left">[0, 0, 0, 0, 0, 0, 0, 0]</td>
 <td>An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group.  Allowed values are 0 - 100, and the sum of all values must total 100 percents.</td>
 </tr>
 <tr>
@@ -1087,21 +1080,21 @@
 <td align="left">
 <a name="nm-settings.property.dcb.priority-group-id"></a>priority-group-id</td>
 <td align="left">array of uint32</td>
-<td align="left">[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L]</td>
+<td align="left">[0, 0, 0, 0, 0, 0, 0, 0]</td>
 <td>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID.  Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.</td>
 </tr>
 <tr>
 <td align="left">
 <a name="nm-settings.property.dcb.priority-strict-bandwidth"></a>priority-strict-bandwidth</td>
 <td align="left">array of uint32</td>
-<td align="left">[False, False, False, False, False, False, False, False]</td>
+<td align="left">[0, 0, 0, 0, 0, 0, 0, 0]</td>
 <td>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.</td>
 </tr>
 <tr>
 <td align="left">
 <a name="nm-settings.property.dcb.priority-traffic-class"></a>priority-traffic-class</td>
 <td align="left">array of uint32</td>
-<td align="left">[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L]</td>
+<td align="left">[0, 0, 0, 0, 0, 0, 0, 0]</td>
 <td>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.</td>
 </tr>
 </tbody>
@@ -1378,14 +1371,14 @@
 <a name="nm-settings.property.ipv4.dad-timeout"></a>dad-timeout</td>
 <td align="left">int32</td>
 <td align="left">-1</td>
-<td>Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network.  If an address conflict is detected, the activation will fail.  A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero).  A value greater than zero is a timeout in milliseconds. The property is currently implemented only for IPv4.</td>
+<td>Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network.  If an address conflict is detected, the activation will fail.  A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or 3 seconds).  A value greater than zero is a timeout in milliseconds.</td>
 </tr>
 <tr>
 <td align="left">
 <a name="nm-settings.property.ipv4.dhcp-client-id"></a>dhcp-client-id</td>
 <td align="left">string</td>
 <td align="left"> </td>
-<td>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. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0. The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet type (01). Currently, these options only work for ethernet type of links. The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id). If unset, a globally configured default is used. If still unset, the client-id from the last lease is reused.</td>
+<td>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. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0.</td>
 </tr>
 <tr>
 <td align="left">
@@ -1441,7 +1434,7 @@
 <a name="nm-settings.property.ipv4.dns-search"></a>dns-search</td>
 <td align="left">array of string</td>
 <td align="left">[]</td>
-<td>Array of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.</td>
+<td>Array of DNS search domains.</td>
 </tr>
 <tr>
 <td align="left">
@@ -1567,7 +1560,7 @@
 <a name="nm-settings.property.ipv6.dad-timeout"></a>dad-timeout</td>
 <td align="left">int32</td>
 <td align="left">-1</td>
-<td>Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network.  If an address conflict is detected, the activation will fail.  A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero).  A value greater than zero is a timeout in milliseconds. The property is currently implemented only for IPv4.</td>
+<td>Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network.  If an address conflict is detected, the activation will fail.  A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or 3 seconds).  A value greater than zero is a timeout in milliseconds.</td>
 </tr>
 <tr>
 <td align="left">
@@ -1616,7 +1609,7 @@
 <a name="nm-settings.property.ipv6.dns-search"></a>dns-search</td>
 <td align="left">array of string</td>
 <td align="left">[]</td>
-<td>Array of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.</td>
+<td>Array of DNS search domains.</td>
 </tr>
 <tr>
 <td align="left">
@@ -1739,13 +1732,6 @@
 </tr>
 <tr>
 <td align="left">
-<a name="nm-settings.property.ip-tunnel.flags"></a>flags</td>
-<td align="left">uint32</td>
-<td align="left">0</td>
-<td>Tunnel flags. Currently the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.</td>
-</tr>
-<tr>
-<td align="left">
 <a name="nm-settings.property.ip-tunnel.flow-label"></a>flow-label</td>
 <td align="left">uint32</td>
 <td align="left">0</td>
@@ -3559,13 +3545,6 @@
 </tr>
 <tr>
 <td align="left">
-<a name="nm-settings.property.802-11-wireless-security.fils"></a>fils</td>
-<td align="left">int32</td>
-<td align="left">0</td>
-<td>Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection.  One of NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (1) (disable FILS), NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (2) (enable FILS if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (3) (enable FILS and fail if not supported).  When set to NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) and no global default is set, FILS will be optionally enabled.</td>
-</tr>
-<tr>
-<td align="left">
 <a name="nm-settings.property.802-11-wireless-security.group"></a>group</td>
 <td align="left">array of string</td>
 <td align="left">[]</td>