diff options
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/html/NetworkManager.conf.html | 2 | ||||
| -rw-r--r-- | docs/api/html/NetworkManager.devhelp2 | 13 | ||||
| -rw-r--r-- | docs/api/html/index.html | 2 | ||||
| -rw-r--r-- | docs/api/html/nm-dbus-types.html | 23 | ||||
| -rw-r--r-- | docs/api/html/nm-settings-dbus.html | 18 | ||||
| -rw-r--r-- | docs/api/html/nm-settings-nmcli.html | 17 | ||||
| -rw-r--r-- | docs/api/version.xml | 2 |
7 files changed, 48 insertions, 29 deletions
diff --git a/docs/api/html/NetworkManager.conf.html b/docs/api/html/NetworkManager.conf.html index e2bd8c54..34063973 100644 --- a/docs/api/html/NetworkManager.conf.html +++ b/docs/api/html/NetworkManager.conf.html @@ -818,7 +818,7 @@ ipv6.ip6-privacy=0 </tr> <tr> <td><p><span class="term"><code class="varname">connection.mptcp-flags</code></span></p></td> -<td><p>If unspecified, the fallback is either 0 (<code class="literal">"disabled"</code>) or 0x22 (<code class="literal">"enabled-on-global-iface,subflow"</code>), depending on <code class="literal">/proc/sys/net/mptcp/enabled</code>.</p></td> +<td><p>If unspecified, the fallback is 0x22 (<code class="literal">"enabled,subflow"</code>). Note that if sysctl <code class="literal">/proc/sys/net/mptcp/enabled</code> is disabled, NetworkManager will still not configure endpoints.</p></td> </tr> <tr> <td><p><span class="term"><code class="varname">connection.dns-over-tls</code></span></p></td> diff --git a/docs/api/html/NetworkManager.devhelp2 b/docs/api/html/NetworkManager.devhelp2 index 7fd00dea..257f6bde 100644 --- a/docs/api/html/NetworkManager.devhelp2 +++ b/docs/api/html/NetworkManager.devhelp2 @@ -852,12 +852,13 @@ <keyword type="constant" name="NM_RADIO_FLAG_WWAN_AVAILABLE" link="nm-dbus-types.htmlnm-dbus-types.html#id-1.4.17.2.35.4.2.1.4.3.1.1id-1.4.17.2.35.4.2.1.4.3.1.2"/> <keyword type="constant" name="NM_MPTCP_FLAGS_NONE" link="nm-dbus-types.htmlnm-dbus-types.html#id-1.4.17.2.36.4.2.1.4.1.1.1id-1.4.17.2.36.4.2.1.4.1.1.2"/> <keyword type="constant" name="NM_MPTCP_FLAGS_DISABLED" link="nm-dbus-types.htmlnm-dbus-types.html#id-1.4.17.2.36.4.2.1.4.2.1.1id-1.4.17.2.36.4.2.1.4.2.1.2"/> - <keyword type="constant" name="NM_MPTCP_FLAGS_ENABLED_ON_GLOBAL_IFACE" link="nm-dbus-types.htmlnm-dbus-types.html#id-1.4.17.2.36.4.2.1.4.3.1.1id-1.4.17.2.36.4.2.1.4.3.1.2"/> - <keyword type="constant" name="NM_MPTCP_FLAGS_ENABLED" link="nm-dbus-types.htmlnm-dbus-types.html#id-1.4.17.2.36.4.2.1.4.4.1.1id-1.4.17.2.36.4.2.1.4.4.1.2"/> - <keyword type="constant" name="NM_MPTCP_FLAGS_SIGNAL" link="nm-dbus-types.htmlnm-dbus-types.html#id-1.4.17.2.36.4.2.1.4.5.1.1id-1.4.17.2.36.4.2.1.4.5.1.2"/> - <keyword type="constant" name="NM_MPTCP_FLAGS_SUBFLOW" link="nm-dbus-types.htmlnm-dbus-types.html#id-1.4.17.2.36.4.2.1.4.6.1.1id-1.4.17.2.36.4.2.1.4.6.1.2"/> - <keyword type="constant" name="NM_MPTCP_FLAGS_BACKUP" link="nm-dbus-types.htmlnm-dbus-types.html#id-1.4.17.2.36.4.2.1.4.7.1.1id-1.4.17.2.36.4.2.1.4.7.1.2"/> - <keyword type="constant" name="NM_MPTCP_FLAGS_FULLMESH" link="nm-dbus-types.htmlnm-dbus-types.html#id-1.4.17.2.36.4.2.1.4.8.1.1id-1.4.17.2.36.4.2.1.4.8.1.2"/> + <keyword type="constant" name="NM_MPTCP_FLAGS_ENABLED" link="nm-dbus-types.htmlnm-dbus-types.html#id-1.4.17.2.36.4.2.1.4.3.1.1id-1.4.17.2.36.4.2.1.4.3.1.2"/> + <keyword type="constant" name="NM_MPTCP_FLAGS_ALSO_WITHOUT_SYSCTL" link="nm-dbus-types.htmlnm-dbus-types.html#id-1.4.17.2.36.4.2.1.4.4.1.1id-1.4.17.2.36.4.2.1.4.4.1.2"/> + <keyword type="constant" name="NM_MPTCP_FLAGS_ALSO_WITHOUT_DEFAULT_ROUTE" link="nm-dbus-types.htmlnm-dbus-types.html#id-1.4.17.2.36.4.2.1.4.5.1.1id-1.4.17.2.36.4.2.1.4.5.1.2"/> + <keyword type="constant" name="NM_MPTCP_FLAGS_SIGNAL" link="nm-dbus-types.htmlnm-dbus-types.html#id-1.4.17.2.36.4.2.1.4.6.1.1id-1.4.17.2.36.4.2.1.4.6.1.2"/> + <keyword type="constant" name="NM_MPTCP_FLAGS_SUBFLOW" link="nm-dbus-types.htmlnm-dbus-types.html#id-1.4.17.2.36.4.2.1.4.7.1.1id-1.4.17.2.36.4.2.1.4.7.1.2"/> + <keyword type="constant" name="NM_MPTCP_FLAGS_BACKUP" link="nm-dbus-types.htmlnm-dbus-types.html#id-1.4.17.2.36.4.2.1.4.8.1.1id-1.4.17.2.36.4.2.1.4.8.1.2"/> + <keyword type="constant" name="NM_MPTCP_FLAGS_FULLMESH" link="nm-dbus-types.htmlnm-dbus-types.html#id-1.4.17.2.36.4.2.1.4.9.1.1id-1.4.17.2.36.4.2.1.4.9.1.2"/> <keyword type="constant" name="NM_VPN_SERVICE_STATE_UNKNOWN" link="nm-vpn-dbus-types.htmlnm-vpn-dbus-types.html#id-1.6.3.2.3.4.2.1.4.1.1.1id-1.6.3.2.3.4.2.1.4.1.1.2"/> <keyword type="constant" name="NM_VPN_SERVICE_STATE_INIT" link="nm-vpn-dbus-types.htmlnm-vpn-dbus-types.html#id-1.6.3.2.3.4.2.1.4.2.1.1id-1.6.3.2.3.4.2.1.4.2.1.2"/> <keyword type="constant" name="NM_VPN_SERVICE_STATE_SHUTDOWN" link="nm-vpn-dbus-types.htmlnm-vpn-dbus-types.html#id-1.6.3.2.3.4.2.1.4.3.1.1id-1.6.3.2.3.4.2.1.4.3.1.2"/> diff --git a/docs/api/html/index.html b/docs/api/html/index.html index 89e8f738..e753eef1 100644 --- a/docs/api/html/index.html +++ b/docs/api/html/index.html @@ -16,7 +16,7 @@ <div> <div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">NetworkManager Reference Manual</p></th></tr></table></div> <div><p class="releaseinfo"> - for NetworkManager 1.39.90 + for NetworkManager 1.40.0 The latest version of this documentation can be found on-line at <a class="ulink" href="https://networkmanager.dev/docs/api/latest/" target="_top">https://networkmanager.dev/docs/api/latest/</a>. diff --git a/docs/api/html/nm-dbus-types.html b/docs/api/html/nm-dbus-types.html index 9935f48c..46152667 100644 --- a/docs/api/html/nm-dbus-types.html +++ b/docs/api/html/nm-dbus-types.html @@ -5366,7 +5366,7 @@ </tr> <tr> <td class="enum_member_name"> -<p>NM_MPTCP_FLAGS_ENABLED_ON_GLOBAL_IFACE</p> +<p>NM_MPTCP_FLAGS_ENABLED</p> <p></p> </td> <td class="enum_member_value"> @@ -5374,14 +5374,14 @@ <p></p> </td> <td class="enum_member_description"> -<p>MPTCP handling is enabled or disabled depending on whether a /0 default route (either IPv4 or IPv6) is configured in the main routing table.</p> +<p>MPTCP is enabled and endpoints will be configured. This flag is implied if any of the other flags indicate that MPTCP is enabled and therefore in most cases unnecessary. Note that if "/proc/sys/net/mptcp/enabled" sysctl is disabled, MPTCP handling is disabled despite this flag. This can be overruled with the "also-without-sysctl" flag. Note that by default interfaces that don't have a default route are excluded from having MPTCP endpoints configured. This can be overruled with the "also-without-default-route" and this affects endpoints per address family.</p> <p></p> </td> <td class="auto-generated"> </td> </tr> <tr> <td class="enum_member_name"> -<p>NM_MPTCP_FLAGS_ENABLED</p> +<p>NM_MPTCP_FLAGS_ALSO_WITHOUT_SYSCTL</p> <p></p> </td> <td class="enum_member_value"> @@ -5389,7 +5389,22 @@ <p></p> </td> <td class="enum_member_description"> -<p>MPTCP is enabled and endpoints will be configured. This flag is implied if any of the other flags indicate that MPTCP is enabled and therefore in most cases unnecessary.</p> +<p>even if MPTCP handling is enabled via the "enabled" flag, it is ignored unless "/proc/sys/net/mptcp/enabled" is on. With this flag, MPTCP endpoints will be configured regardless of the sysctl setting.</p> +<p></p> +</td> +<td class="auto-generated"> </td> +</tr> +<tr> +<td class="enum_member_name"> +<p>NM_MPTCP_FLAGS_ALSO_WITHOUT_DEFAULT_ROUTE</p> +<p></p> +</td> +<td class="enum_member_value"> +<p>= <code class="literal">0x8</code></p> +<p></p> +</td> +<td class="enum_member_description"> +<p>even if MPTCP handling is enabled via the "enabled" flag, it is ignored per-address family unless NetworkManager configures a default route. With this flag, NetworkManager will also configure MPTCP endpoints if there is no default route. This takes effect per-address family.</p> <p></p> </td> <td class="auto-generated"> </td> diff --git a/docs/api/html/nm-settings-dbus.html b/docs/api/html/nm-settings-dbus.html index f0aed252..0903c329 100644 --- a/docs/api/html/nm-settings-dbus.html +++ b/docs/api/html/nm-settings-dbus.html @@ -245,13 +245,15 @@ If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered. - The flag "enabled-on-global-iface" (0x2) means that MPTCP handling is enabled if the interface configures a default route in the main routing table. This choice is per-address family, for example if there is an IPv4 default route 0.0.0.0/0, IPv4 endpoints are configured. + The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags. - The "enabled" (0x4) flag means that MPTCP handling is explicitly enabled. This flag can also be implied from the presence of other flags. + Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless. - If MPTCP handling is enabled, then endpoints will be configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags. + Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that. - If the flags are zero, the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is either "disabled" or "enabled-on-global-iface,subflow" depending on "/proc/sys/net/mptcp/enabled". + When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags. + + If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl. NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp. @@ -1805,9 +1807,9 @@ <td align="left"> </td> <td> The gateway associated with this configuration. This is only meaningful if "addresses" is also set. - The gateway's main purpose is to control the next hop of the standard default route on the device. Hence, the gateway property conflicts with "never-default" and will be automatically dropped if the IP configuration is set to never-default. + Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length. - As an alternative to set the gateway, configure a static default route with /0 as prefix length.</td> + Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</td> </tr> <tr> <td align="left"> @@ -2099,9 +2101,9 @@ <td align="left"> </td> <td> The gateway associated with this configuration. This is only meaningful if "addresses" is also set. - The gateway's main purpose is to control the next hop of the standard default route on the device. Hence, the gateway property conflicts with "never-default" and will be automatically dropped if the IP configuration is set to never-default. + Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length. - As an alternative to set the gateway, configure a static default route with /0 as prefix length.</td> + Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</td> </tr> <tr> <td align="left"> diff --git a/docs/api/html/nm-settings-nmcli.html b/docs/api/html/nm-settings-nmcli.html index 672f9e43..6968e035 100644 --- a/docs/api/html/nm-settings-nmcli.html +++ b/docs/api/html/nm-settings-nmcli.html @@ -217,10 +217,11 @@ <td> <p> Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints.</p> <p> If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered.</p> -<p> The flag "enabled-on-global-iface" (0x2) means that MPTCP handling is enabled if the interface configures a default route in the main routing table. This choice is per-address family, for example if there is an IPv4 default route 0.0.0.0/0, IPv4 endpoints are configured.</p> -<p> The "enabled" (0x4) flag means that MPTCP handling is explicitly enabled. This flag can also be implied from the presence of other flags.</p> -<p> If MPTCP handling is enabled, then endpoints will be configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags.</p> -<p> If the flags are zero, the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is either "disabled" or "enabled-on-global-iface,subflow" depending on "/proc/sys/net/mptcp/enabled".</p> +<p> The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags.</p> +<p> Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless.</p> +<p> Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that.</p> +<p> When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags.</p> +<p> If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl.</p> <p> NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp.</p> <p> Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).</p> <p> @@ -2156,8 +2157,8 @@ <p> Alias: gw4</p> <p> The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</p> -<p> The gateway's main purpose is to control the next hop of the standard default route on the device. Hence, the gateway property conflicts with "never-default" and will be automatically dropped if the IP configuration is set to never-default.</p> -<p> As an alternative to set the gateway, configure a static default route with /0 as prefix length.</p> +<p> Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.</p> +<p> Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</p> <p> Format: string</p> </td> @@ -2453,8 +2454,8 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <p> Alias: gw6</p> <p> The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</p> -<p> The gateway's main purpose is to control the next hop of the standard default route on the device. Hence, the gateway property conflicts with "never-default" and will be automatically dropped if the IP configuration is set to never-default.</p> -<p> As an alternative to set the gateway, configure a static default route with /0 as prefix length.</p> +<p> Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.</p> +<p> Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</p> <p> Format: string</p> </td> diff --git a/docs/api/version.xml b/docs/api/version.xml index d3781d71..32b7211c 100644 --- a/docs/api/version.xml +++ b/docs/api/version.xml @@ -1 +1 @@ -1.39.90 +1.40.0 |