diff options
Diffstat (limited to 'docs/api/html/nm-settings-dbus.html')
| -rw-r--r-- | docs/api/html/nm-settings-dbus.html | 191 |
1 files changed, 133 insertions, 58 deletions
diff --git a/docs/api/html/nm-settings-dbus.html b/docs/api/html/nm-settings-dbus.html index 9810171f..145b2ad0 100644 --- a/docs/api/html/nm-settings-dbus.html +++ b/docs/api/html/nm-settings-dbus.html @@ -157,6 +157,13 @@ Depending on "connection.multi-connect", a profile can (auto)connect only once a </tr> <tr> <td align="left"> +<a name="nm-settings-dbus.property.connection.controller"></a>controller</td> +<td align="left">string</td> +<td align="left"> </td> +<td>Interface name of the controller device or UUID of the controller connection.</td> +</tr> +<tr> +<td align="left"> <a name="nm-settings-dbus.property.connection.dns-over-tls"></a>dns-over-tls</td> <td align="left">int32</td> <td align="left">-1</td> @@ -214,7 +221,9 @@ This feature requires a plugin which supports LLMNR. Otherwise, the setting has <a name="nm-settings-dbus.property.connection.master"></a>master</td> <td align="left">string</td> <td align="left"> </td> -<td>Interface name of the master device or UUID of the master connection.</td> +<td>Interface name of the master device or UUID of the master connection. + +Deprecated 1.46. Use "controller" instead, this is just an alias.</td> </tr> <tr> <td align="left"> @@ -288,6 +297,13 @@ At this time only the "user" [type] is allowed. Any other values are ignored an </tr> <tr> <td align="left"> +<a name="nm-settings-dbus.property.connection.port-type"></a>port-type</td> +<td align="left">string</td> +<td align="left"> </td> +<td>Setting name of the device type of this port's controller connection (eg, "bond"), or NULL if this connection is not a port.</td> +</tr> +<tr> +<td align="left"> <a name="nm-settings-dbus.property.connection.read-only"></a>read-only</td> <td align="left">boolean</td> <td align="left">FALSE</td> @@ -307,7 +323,9 @@ This property is deprecated since version 1.44.This property is deprecated and h <a name="nm-settings-dbus.property.connection.slave-type"></a>slave-type</td> <td align="left">string</td> <td align="left"> </td> -<td>Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</td> +<td>Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave. + +Deprecated 1.46. Use "port-type" instead, this is just an alias.</td> </tr> <tr> <td align="left"> @@ -320,7 +338,7 @@ The stable-id is used for generating IPv6 stable private addresses with ipv6.add Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key. See NetworkManager(8) manual about the secret-key and the host identity. -The '$' character is treated special to perform dynamic substitutions at activation time. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-boot, or every time. The "${CONNECTION}" uses the profile's connection.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" the permanent MAC address of the device. 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}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates. +The '$' character is treated special to perform dynamic substitutions at activation time. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${NETWORK_SSID}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-SSID, per-boot, or every time. The "${CONNECTION}" uses the profile's connection.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" the permanent MAC address of the device. "${NETWORK_SSID}" uses the SSID for Wi-Fi networks and falls back to "${CONNECTION}" on other networks. 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}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates. If the value is unset, a global connection default is consulted. If the value is still unset, the default is "default${CONNECTION}" go generate an ID unique per connection profile.</td> </tr> @@ -1288,7 +1306,7 @@ where $vid is either a single id between 1 and 4094 or a range, represented as a <a name="nm-settings-dbus.property.dcb.app-fcoe-flags"></a>app-fcoe-flags</td> <td align="left">NMSettingDcbFlags (uint32)</td> <td align="left"> </td> -<td>Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</td> +<td>Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).</td> </tr> <tr> <td align="left"> @@ -1304,35 +1322,35 @@ Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was reject <a name="nm-settings-dbus.property.dcb.app-fcoe-priority"></a>app-fcoe-priority</td> <td align="left">int32</td> <td align="left">-1</td> -<td>The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</td> +<td>The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the 0x1 (enable) flag.</td> </tr> <tr> <td align="left"> <a name="nm-settings-dbus.property.dcb.app-fip-flags"></a>app-fip-flags</td> <td align="left">NMSettingDcbFlags (uint32)</td> <td align="left"> </td> -<td>Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</td> +<td>Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).</td> </tr> <tr> <td align="left"> <a name="nm-settings-dbus.property.dcb.app-fip-priority"></a>app-fip-priority</td> <td align="left">int32</td> <td align="left">-1</td> -<td>The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</td> +<td>The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the 0x1 (enable) flag.</td> </tr> <tr> <td align="left"> <a name="nm-settings-dbus.property.dcb.app-iscsi-flags"></a>app-iscsi-flags</td> <td align="left">NMSettingDcbFlags (uint32)</td> <td align="left"> </td> -<td>Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</td> +<td>Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).</td> </tr> <tr> <td align="left"> <a name="nm-settings-dbus.property.dcb.app-iscsi-priority"></a>app-iscsi-priority</td> <td align="left">int32</td> <td align="left">-1</td> -<td>The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</td> +<td>The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the 0x1 (enable) flag.</td> </tr> <tr> <td align="left"> @@ -1353,7 +1371,7 @@ Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was reject <a name="nm-settings-dbus.property.dcb.priority-flow-control-flags"></a>priority-flow-control-flags</td> <td align="left">NMSettingDcbFlags (uint32)</td> <td align="left"> </td> -<td>Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</td> +<td>Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).</td> </tr> <tr> <td align="left"> @@ -1367,7 +1385,7 @@ Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was reject <a name="nm-settings-dbus.property.dcb.priority-group-flags"></a>priority-group-flags</td> <td align="left">NMSettingDcbFlags (uint32)</td> <td align="left"> </td> -<td>Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</td> +<td>Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).</td> </tr> <tr> <td align="left"> @@ -1476,7 +1494,9 @@ Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was reject <a name="nm-settings-dbus.property.gsm.apn"></a>apn</td> <td align="left">string</td> <td align="left"> </td> -<td>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.</td> +<td>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. + +If the APN is unset (the default) then it may be detected based on "auto-config" setting. The property can be explicitly set to the empty string to prevent that and use no APN.</td> </tr> <tr> <td align="left"> @@ -1695,9 +1715,9 @@ For other connection types, adding such an automatic route is currently not supp <a name="nm-settings-dbus.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. +<td>Maximum 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. The property is currently implemented only for IPv4. -The property is currently implemented only for IPv4.</td> +A zero value means that no duplicate address detection is performed, -1 means the default value (either the value configured globally in NetworkManger.conf or 200ms). A value greater than zero is a timeout in milliseconds. Note that the time intervals are subject to randomization as per RFC 5227 and so the actual duration can be between half and the full time specified in this property.</td> </tr> <tr> <td align="left"> @@ -1714,7 +1734,9 @@ The special value "duid" generates a RFC4361-compliant client identifier based o The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key. -If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin.</td> +The special value "none" prevents any client identifier from being sent. Note that this is normally not recommended. + +If unset, a globally configured default from NetworkManager.conf is used. If still unset, the default depends on the DHCP plugin. The internal dhcp client will default to "mac" and the dhclient plugin will try to use one from its config file if present, or won't sent any client-id otherwise.</td> </tr> <tr> <td align="left"> @@ -1737,9 +1759,9 @@ If unset, a globally configured default is used. If still unset, the default dep <td align="left">0</td> <td>Flags for the DHCP hostname and FQDN. -Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. +Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) and 0x4 (fqdn-no-update). When no FQDN flag is set and 0x8 (fqdn-clear-flags) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and 0x8 (fqdn-clear-flags) is not set, the standard FQDN flags are set in the request: 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) for IPv4 and 0x1 (fqdn-serv-update) for IPv6. -When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</td> +When this property is set to the default value 0x0 (none), a global default is looked up in NetworkManager configuration. If that value is unset or also 0x0 (none), then the standard FQDN flags described above are sent in the DHCP requests.</td> </tr> <tr> <td align="left"> @@ -1807,15 +1829,17 @@ Set to 2147483647 (MAXINT32) for infinity.</td> <a name="nm-settings-dbus.property.ipv4.dns-options"></a>dns-options</td> <td align="left">array of string</td> <td align="left"> </td> -<td>Array of DNS options as described in man 5 resolv.conf. +<td>Array of DNS options to be added to 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. -The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-aaaa", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". +The following options are directly added to resolv.conf: "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-aaaa", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". See the resolv.conf(5) man page for a detailed description of these options. + +In addition, NetworkManager supports the special options "_no-add-edns0" and "_no-add-trust-ad". They are not added to resolv.conf, and can be used to prevent the automatic addition of options "edns0" and "trust-ad" when using caching DNS plugins (see below). The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. -When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</td> +When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added, unless "_no-add-edns0" and "_no-add-trust-ad" are present.</td> </tr> <tr> <td align="left"> @@ -2002,7 +2026,7 @@ Array of IPv4 route structures. Each IPv4 route structure is composed of 4 32-b <td align="left">3</td> <td>Configure the method for creating the IPv6 interface identifier of addresses for RFC4862 IPv6 Stateless Address Autoconfiguration and IPv6 Link Local. -The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3). +The permitted values are: 0 (eui64), 1 (stable-privacy). 2 (default-or-eui64) or 3 (default). If the property is set to "eui64", the addresses will be generated using the interface token derived from the hardware address. This makes the host part of the address constant, making it possible to track the host's presence when it changes networks. The address changes when the interface hardware is replaced. If a duplicate address is detected, there is no fallback to generate another address. When configured, the "ipv6.token" is used instead of the MAC address to generate addresses for stateless autoconfiguration. @@ -2043,9 +2067,9 @@ For other connection types, adding such an automatic route is currently not supp <a name="nm-settings-dbus.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. +<td>Maximum 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. The property is currently implemented only for IPv4. -The property is currently implemented only for IPv4.</td> +A zero value means that no duplicate address detection is performed, -1 means the default value (either the value configured globally in NetworkManger.conf or 200ms). A value greater than zero is a timeout in milliseconds. Note that the time intervals are subject to randomization as per RFC 5227 and so the actual duration can be between half and the full time specified in this property.</td> </tr> <tr> <td align="left"> @@ -2076,9 +2100,9 @@ When the property is unset, the global value provided for "ipv6.dhcp-duid" is us <td align="left">0</td> <td>Flags for the DHCP hostname and FQDN. -Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. +Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) and 0x4 (fqdn-no-update). When no FQDN flag is set and 0x8 (fqdn-clear-flags) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and 0x8 (fqdn-clear-flags) is not set, the standard FQDN flags are set in the request: 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) for IPv4 and 0x1 (fqdn-serv-update) for IPv6. -When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</td> +When this property is set to the default value 0x0 (none), a global default is looked up in NetworkManager configuration. If that value is unset or also 0x0 (none), then the standard FQDN flags described above are sent in the DHCP requests.</td> </tr> <tr> <td align="left"> @@ -2146,15 +2170,17 @@ Set to 2147483647 (MAXINT32) for infinity.</td> <a name="nm-settings-dbus.property.ipv6.dns-options"></a>dns-options</td> <td align="left">array of string</td> <td align="left"> </td> -<td>Array of DNS options as described in man 5 resolv.conf. +<td>Array of DNS options to be added to 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. -The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-aaaa", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". +The following options are directly added to resolv.conf: "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-aaaa", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". See the resolv.conf(5) man page for a detailed description of these options. + +In addition, NetworkManager supports the special options "_no-add-edns0" and "_no-add-trust-ad". They are not added to resolv.conf, and can be used to prevent the automatic addition of options "edns0" and "trust-ad" when using caching DNS plugins (see below). The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. -When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</td> +When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added, unless "_no-add-edns0" and "_no-add-trust-ad" are present.</td> </tr> <tr> <td align="left"> @@ -2368,14 +2394,14 @@ When set, the token is used as IPv6 interface identifier instead of the hardware <a name="nm-settings-dbus.property.ip-tunnel.encapsulation-limit"></a>encapsulation-limit</td> <td align="left">uint32</td> <td align="left">0</td> -<td>How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. To disable this option, add NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1) to ip-tunnel flags.</td> +<td>How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. To disable this option, add 0x1 (ip6-ign-encap-limit) to ip-tunnel flags.</td> </tr> <tr> <td align="left"> <a name="nm-settings-dbus.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> +<td>Tunnel flags. Currently, the following values are supported: 0x1 (ip6-ign-encap-limit), 0x2 (ip6-use-orig-tclass), 0x4 (ip6-use-orig-flowlabel), 0x8 (ip6-mip6-dev), 0x10 (ip6-rcv-dscp-copy), 0x20 (ip6-use-orig-fwmark). They are valid only for IPv6 tunnels.</td> </tr> <tr> <td align="left"> @@ -2410,7 +2436,7 @@ When set, the token is used as IPv6 interface identifier instead of the hardware <a name="nm-settings-dbus.property.ip-tunnel.mode"></a>mode</td> <td align="left">uint32</td> <td align="left">0</td> -<td>The tunneling mode. Valid values: NM_IP_TUNNEL_MODE_IPIP (1), NM_IP_TUNNEL_MODE_GRE (2), NM_IP_TUNNEL_MODE_SIT (3), NM_IP_TUNNEL_MODE_ISATAP (4), NM_IP_TUNNEL_MODE_VTI (5), NM_IP_TUNNEL_MODE_IP6IP6 (6), NM_IP_TUNNEL_MODE_IPIP6 (7), NM_IP_TUNNEL_MODE_IP6GRE (8), NM_IP_TUNNEL_MODE_VTI6 (9), NM_IP_TUNNEL_MODE_GRETAP (10) and NM_IP_TUNNEL_MODE_IP6GRETAP (11)</td> +<td>The tunneling mode. Valid values: 1 (ipip), 2 (gre), 3 (sit), 4 (isatap), 5 (vti), 6 (ip6ip6), 7 (ipip6), 8 (ip6gre), 9 (vti6), 10 (gretap) and 11 (ip6gretap)</td> </tr> <tr> <td align="left"> @@ -3175,7 +3201,7 @@ The property is valid only for ports with mode "trunk", "native-tagged", or "nat <a name="nm-settings-dbus.property.proxy.method"></a>method</td> <td align="left">int32</td> <td align="left">0</td> -<td>Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)</td> +<td>Method for proxy configuration, Default is 0 (none)</td> </tr> <tr> <td align="left"> @@ -3275,11 +3301,11 @@ The property is valid only for ports with mode "trunk", "native-tagged", or "nat <td align="left"> </td> <td>Whether to autoprobe virtual functions by a compatible driver. -If set to NM_TERNARY_TRUE (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF. +If set to 1 (true), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF. -If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them. +If set to 0 (false), VFs will not be claimed and no network interfaces will be created for them. -When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_TRUE (1).</td> +When set to -1 (default), the global default is used; in case the global default is unspecified it is assumed to be 1 (true).</td> </tr> <tr> <td align="left"> @@ -3601,7 +3627,7 @@ If the "tc" setting is not present, NetworkManager doesn't touch the filters pre <a name="nm-settings-dbus.property.tun.mode"></a>mode</td> <td align="left">uint32</td> <td align="left">1</td> -<td>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.</td> +<td>The operating mode of the virtual device. Allowed values are 1 (tun) to create a layer 3 device and 2 (tap) to create an Ethernet-like layer 2 one.</td> </tr> <tr> <td align="left"> @@ -3690,7 +3716,7 @@ If the "tc" setting is not present, NetworkManager doesn't touch the filters pre <a name="nm-settings-dbus.property.vlan.flags"></a>flags</td> <td align="left">NMVlanFlags (uint32)</td> <td align="left"> </td> -<td>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). +<td>One or more flags which control the behavior and features of the VLAN interface. Flags include 0x1 (reorder-headers) (reordering of output packet headers), 0x2 (gvrp) (use of the GVRP protocol), and 0x4 (loose-binding) (loose binding of the interface to its master device's operating state). 0x8 (mvrp) (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.</td> </tr> @@ -4172,7 +4198,7 @@ Currently, NetworkManager itself does nothing with this information. However, s3 <a name="nm-settings-dbus.property.802-3-ethernet.wake-on-lan"></a>wake-on-lan</td> <td align="left">uint32</td> <td align="left">1</td> -<td>The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</td> +<td>The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of 0x2 (phy), 0x4 (unicast), 0x8 (multicast), 0x10 (broadcast), 0x20 (arp), 0x40 (magic) or the special values 0x1 (default) (to use global settings) and 0x8000 (ignore) (to disable management of Wake-on-LAN in NetworkManager).</td> </tr> <tr> <td align="left"> @@ -4301,13 +4327,13 @@ Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ip <a name="nm-settings-dbus.property.802-11-wireless.ap-isolation"></a>ap-isolation</td> <td align="left">NMTernary (int32)</td> <td align="left"> </td> -<td>Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from NM_TERNARY_DEFAULT (-1) only when the interface is configured in AP mode. +<td>Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from -1 (default) only when the interface is configured in AP mode. -If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc. +If set to 1 (true), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc. -If set to NM_TERNARY_FALSE (0), devices can talk to each other. +If set to 0 (false), devices can talk to each other. -When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_FALSE (0).</td> +When set to -1 (default), the global default is used; in case the global default is unspecified it is assumed to be 0 (false).</td> </tr> <tr> <td align="left"> @@ -4393,7 +4419,7 @@ Note that marking the network as hidden may be a privacy issue for you (in infra <a name="nm-settings-dbus.property.802-11-wireless.mac-address-randomization"></a>mac-address-randomization</td> <td align="left">uint32</td> <td align="left">0</td> -<td>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). +<td>One of 0 (default) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), 1 (never) (never randomize the MAC address), or 2 (always) (always randomize the MAC address). This property is deprecated since version 1.4.Use the "cloned-mac-address" property instead.</td> </tr> @@ -4416,7 +4442,7 @@ This property is deprecated since version 1.4.Use the "cloned-mac-address" prope <a name="nm-settings-dbus.property.802-11-wireless.powersave"></a>powersave</td> <td align="left">uint32</td> <td align="left">0</td> -<td>One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.</td> +<td>One of 2 (disable) (disable Wi-Fi power saving), 3 (enable) (enable Wi-Fi power saving), 1 (ignore) (don't touch currently configure setting) or 0 (default) (use the globally configured value). All other values are reserved.</td> </tr> <tr> <td align="left"> @@ -4464,7 +4490,7 @@ This property is deprecated since version 1.44.This property is not implemented <a name="nm-settings-dbus.property.802-11-wireless.wake-on-wlan"></a>wake-on-wlan</td> <td align="left">uint32</td> <td align="left">1</td> -<td>The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</td> +<td>The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of 0x2 (any), 0x4 (disconnect), 0x8 (magic), 0x10 (gtk-rekey-failure), 0x20 (eap-identity-request), 0x40 (4way-handshake), 0x80 (rfkill-release), 0x100 (tcp) or the special values 0x1 (default) (to use global settings) and 0x8000 (ignore) (to disable management of Wake-on-LAN in NetworkManager).</td> </tr> </tbody> </table></div> @@ -4499,7 +4525,7 @@ This property is deprecated since version 1.44.This property is not implemented <a name="nm-settings-dbus.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> +<td>Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of 0 (default) (use global default value), 1 (disable) (disable FILS), 2 (optional) (enable FILS if the supplicant and the access point support it) or 3 (required) (enable FILS and fail if not supported). When set to 0 (default) and no global default is set, FILS will be optionally enabled.</td> </tr> <tr> <td align="left"> @@ -4550,7 +4576,7 @@ This property must be set for any Wi-Fi connection that uses security.</td> <a name="nm-settings-dbus.property.802-11-wireless-security.pmf"></a>pmf</td> <td align="left">int32</td> <td align="left">0</td> -<td>Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE (1) (disable PMF), NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL (2) (enable PMF if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED (3) (enable PMF and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) and no global default is set, PMF will be optionally enabled.</td> +<td>Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of 0 (default) (use global default value), 1 (disable) (disable PMF), 2 (optional) (enable PMF if the supplicant and the access point support it) or 3 (required) (enable PMF and fail if not supported). When set to 0 (default) and no global default is set, PMF will be optionally enabled.</td> </tr> <tr> <td align="left"> @@ -4585,7 +4611,7 @@ This property must be set for any Wi-Fi connection that uses security.</td> <a name="nm-settings-dbus.property.802-11-wireless-security.wep-key-type"></a>wep-key-type</td> <td align="left">NMWepKeyType (uint32)</td> <td align="left"> </td> -<td>Controls the interpretation of WEP keys. Allowed values are NM_WEP_KEY_TYPE_KEY (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or NM_WEP_KEY_TYPE_PASSPHRASE (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.</td> +<td>Controls the interpretation of WEP keys. Allowed values are 1 (key), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or 2 (passphrase), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.</td> </tr> <tr> <td align="left"> @@ -4752,7 +4778,7 @@ WPS can be disabled by setting this property to a value of 1.</td> <td align="left"> </td> <td>Whether the system hostname can be determined from DHCP on this connection. -When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).</td> +When set to -1 (default), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be 1 (true).</td> </tr> <tr> <td align="left"> @@ -4761,18 +4787,18 @@ When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used <td align="left"> </td> <td>Whether the system hostname can be determined from reverse DNS lookup of addresses on this device. -When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).</td> +When set to -1 (default), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be 1 (true).</td> </tr> <tr> <td align="left"> <a name="nm-settings-dbus.property.hostname.only-from-default"></a>only-from-default</td> <td align="left">NMTernary (int32)</td> <td align="left"> </td> -<td>If set to NM_TERNARY_TRUE (1), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6). +<td>If set to 1 (true), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6). -If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn't have the default route. +If set to 0 (false), the hostname can be set from this device even if it doesn't have the default route. -When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_FALSE (0).</td> +When set to -1 (default), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be 0 (false).</td> </tr> <tr> <td align="left"> @@ -4790,7 +4816,56 @@ Negative values have the special effect of excluding other connections with a gr </div> <hr> <div class="refsect2"> -<a name="id-1.2.9.4.53"></a><h3>link setting</h3> +<a name="id-1.2.9.4.53"></a><h3>hsr setting</h3> +<p>HSR/PRP Settings.</p> +<div class="informaltable"><table class="informaltable" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td align="left"> +<a name="nm-settings-dbus.property.hsr.multicast-spec"></a>multicast-spec</td> +<td align="left">uint32</td> +<td align="left">0</td> +<td>The last byte of supervision address.</td> +</tr> +<tr> +<td align="left"> +<a name="nm-settings-dbus.property.hsr.port1"></a>port1</td> +<td align="left">string</td> +<td align="left"> </td> +<td>The port1 interface name of the HSR. This property is mandatory.</td> +</tr> +<tr> +<td align="left"> +<a name="nm-settings-dbus.property.hsr.port2"></a>port2</td> +<td align="left">string</td> +<td align="left"> </td> +<td>The port2 interface name of the HSR. This property is mandatory.</td> +</tr> +<tr> +<td align="left"> +<a name="nm-settings-dbus.property.hsr.prp"></a>prp</td> +<td align="left">boolean</td> +<td align="left">FALSE</td> +<td>The protocol used by the interface, whether it is PRP or HSR.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="id-1.2.9.4.54"></a><h3>link setting</h3> <p>Link settings.</p> <div class="informaltable"><table class="informaltable" border="1"> <colgroup> @@ -4839,7 +4914,7 @@ Negative values have the special effect of excluding other connections with a gr </div> <hr> <div class="refsect2"> -<a name="id-1.2.9.4.54"></a><h3>loopback setting</h3> +<a name="id-1.2.9.4.55"></a><h3>loopback setting</h3> <p>Loopback Link Settings.</p> <div class="informaltable"><table class="informaltable" border="1"> <colgroup> @@ -4865,7 +4940,7 @@ Negative values have the special effect of excluding other connections with a gr </div> <hr> <div class="refsect2"> -<a name="id-1.2.9.4.55"></a><h3>ovs-external-ids setting</h3> +<a name="id-1.2.9.4.56"></a><h3>ovs-external-ids setting</h3> <p>OVS External IDs Settings.</p> <div class="informaltable"><table class="informaltable" border="1"> <colgroup> @@ -4891,7 +4966,7 @@ Negative values have the special effect of excluding other connections with a gr </div> <hr> <div class="refsect2"> -<a name="id-1.2.9.4.56"></a><h3>ovs-other-config setting</h3> +<a name="id-1.2.9.4.57"></a><h3>ovs-other-config setting</h3> <p>OVS Other Config Settings.</p> <div class="informaltable"><table class="informaltable" border="1"> <colgroup> @@ -4917,7 +4992,7 @@ Negative values have the special effect of excluding other connections with a gr </div> <hr> <div class="refsect2"> -<a name="id-1.2.9.4.57"></a><h3>veth setting</h3> +<a name="id-1.2.9.4.58"></a><h3>veth setting</h3> <p>Veth Settings.</p> <div class="informaltable"><table class="informaltable" border="1"> <colgroup> |