-
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-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
-
-