From e74c568b07b50b97873fb4ee1d776dedefbd54d6 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 1 Oct 2021 23:05:04 +0200 Subject: New upstream version 1.32.12 --- docs/libnm/html/NMSettingIPConfig.html | 680 ++++++++------------------------- 1 file changed, 168 insertions(+), 512 deletions(-) (limited to 'docs/libnm/html/NMSettingIPConfig.html') diff --git a/docs/libnm/html/NMSettingIPConfig.html b/docs/libnm/html/NMSettingIPConfig.html index 5a9a903e..e19560b5 100644 --- a/docs/libnm/html/NMSettingIPConfig.html +++ b/docs/libnm/html/NMSettingIPConfig.html @@ -16,8 +16,7 @@ Top  |  Description  |  - Object Hierarchy  |  - Properties + Object Hierarchy Home Up @@ -692,6 +691,22 @@ addressing, routing, and name service properties

+gboolean + + +nm_ip_routing_rule_get_uid_range () + + + + +void + + +nm_ip_routing_rule_set_uid_range () + + + + int @@ -1109,6 +1124,14 @@ addressing, routing, and name service properties

+ +int + + +nm_setting_ip_config_get_required_timeout () + + + const char * @@ -1157,129 +1180,6 @@ addressing, routing, and name service properties

-
-

Properties

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-GPtrArray *addressesRead / Write
intdad-timeoutRead / Write
-char *dhcp-hostnameRead / Write
guintdhcp-hostname-flagsRead / Write
-char *dhcp-iaidRead / Write
GStrvdhcp-reject-serversRead / Write
gbooleandhcp-send-hostnameRead / Write
intdhcp-timeoutRead / Write
GStrvdnsRead / Write
GStrvdns-optionsRead / Write
intdns-priorityRead / Write
GStrvdns-searchRead / Write
-char *gatewayRead / Write
gbooleanignore-auto-dnsRead / Write
gbooleanignore-auto-routesRead / Write
gbooleanmay-failRead / Write
-char *methodRead / Write
gbooleannever-defaultRead / Write
gint64route-metricRead / Write
guintroute-tableRead / Write
-GPtrArray *routesRead / Write
-

Types and Values

@@ -1450,6 +1350,10 @@ addressing, routing, and name service properties

+ + + + @@ -1529,10 +1433,6 @@ addressing, routing, and name service properties

- - - - @@ -1549,11 +1449,6 @@ addressing, routing, and name service properties

├── NMDhcpHostnameFlags ├── NMIPAddressCmpFlags ╰── NMIPRoutingRuleAsStringFlags - GObject - ╰──NMSetting - ╰── NMSettingIPConfig - ├──NMSettingIP4Config - ╰──NMSettingIP6Config
@@ -1819,9 +1714,13 @@ nm_ip_address_dup (

Returns

a copy of address -.

+

+

This API was part of public headers before 1.32.0 but +was erroneously not exported in the ABI. It is thus only +usable since 1.32.0.

[transfer full]

+

Since: 1.32


@@ -2416,9 +2315,13 @@ nm_ip_route_dup (

Returns

a copy of route -.

+

+

This API was part of public headers before 1.32.0 but +was erroneously not exported in the ABI. It is thus only +usable since 1.32.0.

[transfer full]

+

Since: 1.32


@@ -4176,6 +4079,86 @@ unset.


+

nm_ip_routing_rule_get_uid_range ()

+
gboolean
+nm_ip_routing_rule_get_uid_range (const NMIPRoutingRule *self,
+                                  guint32 *out_range_start,
+                                  guint32 *out_range_end);
+
+

Parameters

+
#defineNM_SETTING_IP_CONFIG_REQUIRED_TIMEOUT
#define NM_SETTING_IP_CONFIG_DHCP_IAID
NM_SETTING_DNS_OPTION_TRUST_AD
 NMSettingIPConfig
enum NMDhcpHostnameFlags
+++++ + + + + + + + + + + + + + + + + + +

self

the NMIPRoutingRule instance

 

out_range_start

returns the start of the range +or 0 if the range is not set.

[out][allow-none]

out_range_end

returns the end of the range +or 0 if the range is not set.

[out][allow-none]
+
+
+

Returns

+

TRUE if a uid range is set.

+
+

Since: 1.32. Due to a bug, the symbols of this function

+ +
+
+

nm_ip_routing_rule_set_uid_range ()

+
void
+nm_ip_routing_rule_set_uid_range (NMIPRoutingRule *self,
+                                  guint32 uid_range_start,
+                                  guint32 uid_range_end);
+

For a valid range, start must be less or equal to end. +If set to an invalid range, the range gets unset.

+
+

Parameters

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

self

the NMIPRoutingRule instance

 

uid_range_start

the uid_range start to set.

 

uid_range_end

the uid_range start to set.

 
+
+

Since: 1.32. Due to a bug, the symbols of this function

+
+
+

nm_ip_routing_rule_cmp ()

int
 nm_ip_routing_rule_cmp (const NMIPRoutingRule *rule,
@@ -4363,7 +4346,7 @@ nm_setting_ip_config_get_method (
 

Returns

-

the “method” property of the setting; see +

the “method” property of the setting; see NMSettingIP4Config and NMSettingIP6Config for details of the methods available with each type.

@@ -5402,7 +5385,7 @@ nm_setting_ip_config_clear_routes (

nm_setting_ip_config_get_route_metric ()

gint64
 nm_setting_ip_config_get_route_metric (NMSettingIPConfig *setting);
-

Returns the value contained in the “route-metric” +

Returns the value contained in the “route-metric” property.

Parameters

@@ -5422,7 +5405,7 @@ property.

Returns

the route metric that is used for routes that don't explicitly -specify a metric. See “route-metric” for more details.

+specify a metric. See “route-metric” for more details.


@@ -5430,7 +5413,7 @@ specify a metric. See

nm_setting_ip_config_get_route_table ()

guint32
 nm_setting_ip_config_get_route_table (NMSettingIPConfig *setting);
-

Returns the value contained in the “route-table” +

Returns the value contained in the “route-table” property.

Parameters

@@ -5614,7 +5597,7 @@ nm_setting_ip_config_clear_routing_rules
gboolean
 nm_setting_ip_config_get_ignore_auto_routes
                                (NMSettingIPConfig *setting);
-

Returns the value contained in the “ignore-auto-routes” +

Returns the value contained in the “ignore-auto-routes” property.

Parameters

@@ -5643,7 +5626,7 @@ ignored.

gboolean
 nm_setting_ip_config_get_ignore_auto_dns
                                (NMSettingIPConfig *setting);
-

Returns the value contained in the “ignore-auto-dns” +

Returns the value contained in the “ignore-auto-dns” property.

Parameters

@@ -5672,7 +5655,7 @@ should be ignored.

const char *
 nm_setting_ip_config_get_dhcp_hostname
                                (NMSettingIPConfig *setting);
-

Returns the value contained in the “dhcp-hostname” +

Returns the value contained in the “dhcp-hostname” property.

Parameters

@@ -5700,7 +5683,7 @@ property.

gboolean
 nm_setting_ip_config_get_dhcp_send_hostname
                                (NMSettingIPConfig *setting);
-

Returns the value contained in the “dhcp-send-hostname” +

Returns the value contained in the “dhcp-send-hostname” property.

Parameters

@@ -5730,7 +5713,7 @@ update DNS information for this machine.

gboolean
 nm_setting_ip_config_get_never_default
                                (NMSettingIPConfig *setting);
-

Returns the value contained in the “never-default” +

Returns the value contained in the “never-default” property.

Parameters

@@ -5758,7 +5741,7 @@ connection

nm_setting_ip_config_get_may_fail ()

gboolean
 nm_setting_ip_config_get_may_fail (NMSettingIPConfig *setting);
-

Returns the value contained in the “may-fail” +

Returns the value contained in the “may-fail” property.

Parameters

@@ -5803,7 +5786,7 @@ nm_setting_ip_config_get_dad_timeout (

Returns

-

the “dad-timeout” property.

+

the “dad-timeout” property.

Since: 1.2

@@ -5812,7 +5795,7 @@ nm_setting_ip_config_get_dad_timeout (

nm_setting_ip_config_get_dhcp_timeout ()

int
 nm_setting_ip_config_get_dhcp_timeout (NMSettingIPConfig *setting);
-

Returns the value contained in the “dhcp-timeout” +

Returns the value contained in the “dhcp-timeout” property.

Parameters

@@ -5838,10 +5821,39 @@ the particular kind of device.


+

nm_setting_ip_config_get_required_timeout ()

+
int
+nm_setting_ip_config_get_required_timeout
+                               (NMSettingIPConfig *setting);
+

Returns the value contained in the “required-timeout” +property.

+
+

Parameters

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

setting

the NMSettingIPConfig

 
+
+
+

Returns

+

the required timeout for the address family

+
+

Since: 1.34, 1.32.4

+
+
+

nm_setting_ip_config_get_dhcp_iaid ()

const char *
 nm_setting_ip_config_get_dhcp_iaid (NMSettingIPConfig *setting);
-

Returns the value contained in the “dhcp-iaid” +

Returns the value contained in the “dhcp-iaid” property.

Parameters

@@ -5870,7 +5882,7 @@ property.

NMDhcpHostnameFlags
 nm_setting_ip_config_get_dhcp_hostname_flags
                                (NMSettingIPConfig *setting);
-

Returns the value contained in the “dhcp-hostname-flags” +

Returns the value contained in the “dhcp-hostname-flags” property.

Parameters

@@ -6339,6 +6351,12 @@ rule verfies or fail.


+

NM_SETTING_IP_CONFIG_REQUIRED_TIMEOUT

+
#define NM_SETTING_IP_CONFIG_REQUIRED_TIMEOUT    "required-timeout"
+
+
+
+

NM_SETTING_IP_CONFIG_DHCP_IAID

#define NM_SETTING_IP_CONFIG_DHCP_IAID           "dhcp-iaid"
 
@@ -6459,11 +6477,6 @@ rule verfies or fail.


-

NMSettingIPConfig

-
typedef struct _NMSettingIPConfig NMSettingIPConfig;
-
-
-

enum NMDhcpHostnameFlags

NMDhcpHostnameFlags describe flags related to the DHCP hostname and FQDN.

@@ -6533,363 +6546,6 @@ incompatible with any other FQDN flag.

-

Property Details

-
-

The “addresses” property

-
  “addresses”                GPtrArray *
-

Array of IP addresses.

-

[type GPtrArray(NMIPAddress)]

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-
-
-
-

The “dad-timeout” property

-
  “dad-timeout”              int
-

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.

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-

Allowed values: [-1,30000]

-

Default value: -1

-

Since: 1.2

-
-
-
-

The “dhcp-hostname” property

-
  “dhcp-hostname”            char *
-

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

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “dhcp-hostname-flags” property

-
  “dhcp-hostname-flags”      guint
-

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, -NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED and -NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE. When no FQDN flag is set and -NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS 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 is not set, the standard FQDN flags -are set in the request: -NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE, -NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED for IPv4 and -NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE for IPv6.

-

When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE, -a global default is looked up in NetworkManager configuration. If that value -is unset or also NM_DHCP_HOSTNAME_FLAG_NONE, then the standard FQDN flags -described above are sent in the DHCP requests.

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-

Default value: 0

-

Since: 1.22

-
-
-
-

The “dhcp-iaid” property

-
  “dhcp-iaid”                char *
-

A string containing the "Identity Association Identifier" (IAID) used -by the DHCP client. The property is a 32-bit decimal value or a -special value among "mac", "perm-mac", "ifname" and "stable". When -set to "mac" (or "perm-mac"), the last 4 bytes of the current (or -permanent) MAC address are used as IAID. When set to "ifname", the -IAID is computed by hashing the interface name. The special value -"stable" can be used to generate an IAID based on the stable-id (see -connection.stable-id), a per-host key and the interface name. When -the property is unset, the value from global configuration is used; -if no global default is set then the IAID is assumed to be -"ifname". Note that at the moment this property is ignored for IPv6 -by dhclient, which always derives the IAID from the MAC address.

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-

Default value: NULL

-

Since: 1.22

-
-
-
-

The “dhcp-reject-servers” property

-
  “dhcp-reject-servers”      GStrv
-

Array of servers from which DHCP offers must be rejected. This property -is useful to avoid getting a lease from misconfigured or rogue servers.

-

For DHCPv4, each element must be an IPv4 address, optionally -followed by a slash and a prefix length (e.g. "192.168.122.0/24").

-

This property is currently not implemented for DHCPv6.

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-

Since: 1.28

-
-
-
-

The “dhcp-send-hostname” property

-
  “dhcp-send-hostname”       gboolean
-

If TRUE, a hostname is sent to the DHCP server when acquiring a lease. -Some DHCP servers use this hostname to update DNS databases, essentially -providing a static hostname for the computer. If the -“dhcp-hostname” property is NULL and this property is -TRUE, the current persistent hostname of the computer is sent.

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-

Default value: TRUE

-
-
-
-

The “dhcp-timeout” property

-
  “dhcp-timeout”             int
-

A timeout for a DHCP transaction in seconds. If zero (the default), a -globally configured default is used. If still unspecified, a device specific -timeout is used (usually 45 seconds).

-

Set to 2147483647 (MAXINT32) for infinity.

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-

Allowed values: >= 0

-

Default value: 0

-
-
-
-

The “dns” property

-
  “dns”                      GStrv
-

Array of IP addresses of DNS servers.

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-
-
-
-

The “dns-options” property

-
  “dns-options”              GStrv
-

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.

-

The currently supported options are "attempts", "debug", "edns0", -"inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", -"no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", -"single-request-reopen", "timeout", "trust-ad", "use-vc".

-

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.

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-

Since: 1.2

-
-
-
-

The “dns-priority” property

-
  “dns-priority”             int
-

DNS servers priority.

-

The relative priority for DNS servers specified by this setting. A lower -numerical value is better (higher priority).

-

Negative values have the special effect of excluding other configurations -with a greater numerical priority value; so in presence of at least one negative -priority, only DNS servers from connections with the lowest priority value will be used. -To avoid all DNS leaks, set the priority of the profile that should be used -to the most negative value of all active connections profiles.

-

Zero selects a globally configured default value. If the latter is missing -or zero too, it defaults to 50 for VPNs (including WireGuard) 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.

-

When multiple devices have configurations with the same priority, VPNs will be -considered first, then devices with the best (lowest metric) default -route and then all other devices.

-

When using dns=default, servers with higher priority will be on top of -resolv.conf. To prioritize a given server over another one within the -same connection, just specify them in the desired order. -Note that commonly the resolver tries name servers in /etc/resolv.conf -in the order listed, proceeding with the next server in the list -on failure. See for example the "rotate" option of the dns-options setting. -If there are any negative DNS priorities, then only name servers from -the devices with that lowest priority will be considered.

-

When using a DNS resolver that supports Conditional Forwarding or -Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection -is used to query domains in its search list. The search domains determine which -name servers to ask, and the DNS priority is used to prioritize -name servers based on the domain. Queries for domains not present in any -search list are routed through connections having the '~.' special wildcard -domain, which is added automatically to connections with the default route -(or can be added manually). When multiple connections specify the same domain, the -one with the best priority (lowest numerical value) wins. If a sub domain -is configured on another interface it will be accepted regardless the priority, -unless parent domain on the other interface has a negative priority, which causes -the sub domain to be shadowed. -With Split DNS one can avoid undesired DNS leaks by properly configuring -DNS priorities and the search domains, so that only name servers of the desired -interface are configured.

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-

Default value: 0

-

Since: 1.4

-
-
-
-

The “dns-search” property

-
  “dns-search”               GStrv
-

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.

-

When using a DNS plugin that supports Conditional Forwarding or -Split DNS, then the search domains specify which name servers to -query. This makes the behavior different from running with plain -/etc/resolv.conf. For more information see also the dns-priority setting.

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-
-
-
-

The “gateway” property

-
  “gateway”                  char *
-

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.

-

As an alternative to set the gateway, configure a static default route with /0 as prefix -length.

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “ignore-auto-dns” property

-
  “ignore-auto-dns”          gboolean
-

When “method” is set to "auto" and this property to -TRUE, automatically configured name servers and search domains are -ignored and only name servers and search domains specified in the -“dns” and “dns-search” properties, if -any, are used.

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-

Default value: FALSE

-
-
-
-

The “ignore-auto-routes” property

-
  “ignore-auto-routes”       gboolean
-

When “method” is set to "auto" and this property to -TRUE, automatically configured routes are ignored and only routes -specified in the “routes” property, if any, are used.

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-

Default value: FALSE

-
-
-
-

The “may-fail” property

-
  “may-fail”                 gboolean
-

If TRUE, allow overall network configuration to proceed even if the -configuration specified by this property times out. Note that at least -one IP configuration must succeed or overall network configuration will -still fail. For example, in IPv6-only networks, setting this property to -TRUE on the NMSettingIP4Config allows the overall network configuration -to succeed if IPv4 configuration fails but IPv6 configuration completes -successfully.

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-

Default value: TRUE

-
-
-
-

The “method” property

-
  “method”                   char *
-

IP configuration method.

-

NMSettingIP4Config and NMSettingIP6Config both support "disabled", -"auto", "manual", and "link-local". See the subclass-specific -documentation for other values.

-

In general, for the "auto" method, properties such as -“dns” and “routes” specify information -that is added on to the information returned from automatic -configuration. The “ignore-auto-routes” and -“ignore-auto-dns” properties modify this behavior.

-

For methods that imply no upstream network, such as "shared" or -"link-local", these properties must be empty.

-

For IPv4 method "shared", the IP subnet can be configured by adding one -manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the -shared method must be configured on the interface which shares the internet -to a subnet, not on the uplink which is shared.

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “never-default” property

-
  “never-default”            gboolean
-

If TRUE, this connection will never be the default connection for this -IP type, meaning it will never be assigned the default route by -NetworkManager.

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-

Default value: FALSE

-
-
-
-

The “route-metric” property

-
  “route-metric”             gint64
-

The default metric for routes that don't explicitly specify a metric. -The default value -1 means that the metric is chosen automatically -based on the device type. -The metric applies to dynamic routes, manual (static) routes that -don't have an explicit metric setting, address prefix routes, and -the default route. -Note that for IPv6, the kernel accepts zero (0) but coerces it to -1024 (user default). Hence, setting this property to zero effectively -mean setting it to 1024. -For IPv4, zero is a regular value for the metric.

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-

Allowed values: [-1,4294967295]

-

Default value: -1

-
-
-
-

The “route-table” property

-
  “route-table”              guint
-

Enable policy routing (source routing) and set the routing table used when adding routes.

-

This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes -and static routes. But note that static routes can individually overwrite the setting -by explicitly specifying a non-zero routing table.

-

If the table setting is left at zero, it is eligible to be overwritten via global -configuration. If the property is zero even after applying the global configuration -value, policy routing is disabled for the address family of this connection.

-

Policy routing disabled means that NetworkManager will add all routes to the main -table (except static routes that explicitly configure a different table). Additionally, -NetworkManager will not delete any extraneous routes from tables except the main table. -This is to preserve backward compatibility for users who manage routing tables outside -of NetworkManager.

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-

Default value: 0

-

Since: 1.10

-
-
-
-

The “routes” property

-
  “routes”                   GPtrArray *
-

Array of IP routes.

-

[type GPtrArray(NMIPRoute)]

-

Owner: NMSettingIPConfig

-

Flags: Read / Write

-
-
- -- cgit 1.3.0-6-gf8a5