GI.NM.Objects.SettingIPConfig

No description available in the introspection data.

Exported types

newtype SettingIPConfig

Memory-managed wrapper type.

Constructors

SettingIPConfig (ManagedPtr SettingIPConfig)

Instances

Eq SettingIPConfig

Defined in GI.NM.Objects.SettingIPConfig

Methods

(==) :: SettingIPConfig -> SettingIPConfig -> Bool

(/=) :: SettingIPConfig -> SettingIPConfig -> Bool

GObject SettingIPConfig

Defined in GI.NM.Objects.SettingIPConfig

ManagedPtrNewtype SettingIPConfig

Defined in GI.NM.Objects.SettingIPConfig

Methods

toManagedPtr :: SettingIPConfig -> ManagedPtr SettingIPConfig

TypedObject SettingIPConfig

Defined in GI.NM.Objects.SettingIPConfig

Methods

glibType :: IO GType

HasParentTypes SettingIPConfig

Defined in GI.NM.Objects.SettingIPConfig

IsGValue (Maybe SettingIPConfig)

Convert SettingIPConfig to and from GValue. See toGValue and fromGValue.

Defined in GI.NM.Objects.SettingIPConfig

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe SettingIPConfig -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe SettingIPConfig)

type ParentTypes SettingIPConfig

Defined in GI.NM.Objects.SettingIPConfig

type ParentTypes SettingIPConfig = '[Setting, Object]

class (GObject o, IsDescendantOf SettingIPConfig o) => IsSettingIPConfig o

Type class for types which can be safely cast to SettingIPConfig, for instance with toSettingIPConfig.

Instances

(GObject o, IsDescendantOf SettingIPConfig o) => IsSettingIPConfig o

Defined in GI.NM.Objects.SettingIPConfig

toSettingIPConfig :: (MonadIO m, IsSettingIPConfig o) => o -> m SettingIPConfig

Cast to SettingIPConfig, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

addAddress, addDhcpRejectServer, addDns, addDnsOption, addDnsSearch, addRoute, addRoutingRule, bindProperty, bindPropertyFull, clearAddresses, clearDhcpRejectServers, clearDns, clearDnsOptions, clearDnsSearches, clearRoutes, clearRoutingRules, compare, diff, duplicate, enumerateValues, forceFloating, freezeNotify, getv, hasDnsOptions, isFloating, notify, notifyByPspec, optionClearByName, optionGet, optionGetAllNames, optionGetBoolean, optionGetUint32, optionSet, optionSetBoolean, optionSetUint32, ref, refSink, removeAddress, removeAddressByValue, removeDhcpRejectServer, removeDns, removeDnsByValue, removeDnsOption, removeDnsOptionByValue, removeDnsSearch, removeDnsSearchByValue, removeRoute, removeRouteByValue, removeRoutingRule, runDispose, stealData, stealQdata, thawNotify, toString, unref, verify, verifySecrets, watchClosure.

Getters

getAddress, getAutoRouteExtGw, getDadTimeout, getData, getDbusPropertyType, getDhcpDscp, getDhcpHostname, getDhcpHostnameFlags, getDhcpIaid, getDhcpRejectServers, getDhcpSendHostname, getDhcpSendRelease, getDhcpTimeout, getDns, getDnsOption, getDnsPriority, getDnsSearch, getGateway, getIgnoreAutoDns, getIgnoreAutoRoutes, getMayFail, getMethod, getName, getNeverDefault, getNumAddresses, getNumDns, getNumDnsOptions, getNumDnsSearches, getNumRoutes, getNumRoutingRules, getProperty, getQdata, getReplaceLocalRule, getRequiredTimeout, getRoute, getRouteMetric, getRouteTable, getRoutingRule, getSecretFlags.

Setters

setData, setDataFull, setProperty, setSecretFlags.

addAddress

settingIPConfigAddAddress

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> IPAddress

address: the new address to add

-> m Bool

Returns: True if the address was added; False if the address was already known.

Adds a new IP address and associated information to the setting. The given address is duplicated internally and is not changed by this function.

addDhcpRejectServer

settingIPConfigAddDhcpRejectServer

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Text

server: the DHCP reject server to add

-> m ()

Adds a new DHCP reject server to the setting.

Since: 1.28

addDns

settingIPConfigAddDns

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Text

dns: the IP address of the DNS server to add

-> m Bool

Returns: True if the DNS server was added; False if the server was already known

Before 1.42, setting dns to an invalid string was treated as user-error. Now, also invalid DNS values can be set, but will be rejected later during connectionVerify.

Adds a new DNS server to the setting.

addDnsOption

settingIPConfigAddDnsOption

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Text

dnsOption: the DNS option to add

-> m Bool

Returns: True if the DNS option was added; False otherwise

Adds a new DNS option to the setting.

Since: 1.2

addDnsSearch

settingIPConfigAddDnsSearch

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Text

dnsSearch: the search domain to add

-> m Bool

Returns: True if the DNS search domain was added; False if the search domain was already known

Adds a new DNS search domain to the setting.

addRoute

settingIPConfigAddRoute

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> IPRoute

route: the route to add

-> m Bool

Returns: True if the route was added; False if the route was already known.

Appends a new route and associated information to the setting. The given route is duplicated internally and is not changed by this function. If an identical route (considering attributes as well) already exists, the route is not added and the function returns False.

Note that before 1.10, this function would not consider route attributes and not add a route that has an existing route with same dest/prefix,next_hop,metric parameters.

addRoutingRule

settingIPConfigAddRoutingRule

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> IPRoutingRule

routingRule: the IPRoutingRule to add. The address family of the added rule must be compatible with the setting.

-> m ()

Appends a new routing-rule and associated information to the setting. The given routing rules gets sealed and the reference count is incremented. The function does not check whether an identical rule already exists and always appends the rule to the end of the list.

Since: 1.18

clearAddresses

settingIPConfigClearAddresses

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m ()

Removes all configured addresses.

clearDhcpRejectServers

settingIPConfigClearDhcpRejectServers

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m ()

Removes all configured DHCP reject servers.

Since: 1.28

clearDns

settingIPConfigClearDns

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m ()

Removes all configured DNS servers.

clearDnsOptions

settingIPConfigClearDnsOptions

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Bool

isSet: the dns-options can be either empty or unset (default). Specify how to clear the options.

-> m ()

Removes all configured DNS options.

Since: 1.2

clearDnsSearches

settingIPConfigClearDnsSearches

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m ()

Removes all configured DNS search domains.

clearRoutes

settingIPConfigClearRoutes

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m ()

Removes all configured routes.

clearRoutingRules

settingIPConfigClearRoutingRules

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m ()

Removes all configured routing rules.

Since: 1.18

getAddress

settingIPConfigGetAddress

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Int32

idx: index number of the address to return

-> m IPAddress

Returns: the address at index idx

No description available in the introspection data.

getAutoRouteExtGw

settingIPConfigGetAutoRouteExtGw

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Ternary

Returns: the SettingIPConfig:autoRouteExtGw property of the setting

No description available in the introspection data.

Since: 1.42

getDadTimeout

settingIPConfigGetDadTimeout

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Int32

Returns: the SettingIPConfig:dadTimeout property.

No description available in the introspection data.

Since: 1.2

getDhcpDscp

settingIPConfigGetDhcpDscp

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Text

Returns: the value for the DSCP field for DHCP

Returns the value contained in the SettingIPConfig:dhcpDscp property.

Since: 1.46

getDhcpHostname

settingIPConfigGetDhcpHostname

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Text

Returns: the configured hostname to send to the DHCP server

Returns the value contained in the SettingIPConfig:dhcpHostname property.

getDhcpHostnameFlags

settingIPConfigGetDhcpHostnameFlags

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m [DhcpHostnameFlags]

Returns: flags for the DHCP hostname and FQDN

Returns the value contained in the SettingIPConfig:dhcpHostnameFlags property.

Since: 1.22

getDhcpIaid

settingIPConfigGetDhcpIaid

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Text

Returns: the configured DHCP IAID (Identity Association Identifier)

Returns the value contained in the SettingIPConfig:dhcpIaid property.

Since: 1.42

getDhcpRejectServers

settingIPConfigGetDhcpRejectServers

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m ([Text], Word32)

Returns: A Nothing terminated array of DHCP reject servers. Even if no reject servers are configured, this always returns a non Nothing value.

No description available in the introspection data.

Since: 1.28

getDhcpSendHostname

settingIPConfigGetDhcpSendHostname

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Bool

Returns: True if NetworkManager should send the machine hostname to the DHCP server when requesting addresses to allow the server to automatically update DNS information for this machine.

Returns the value contained in the SettingIPConfig:dhcpSendHostname property.

getDhcpSendRelease

settingIPConfigGetDhcpSendRelease

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Ternary

Returns: the SettingIPConfig:dhcpSendRelease property of the setting

No description available in the introspection data.

Since: 1.48

getDhcpTimeout

settingIPConfigGetDhcpTimeout

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Int32

Returns: the configured DHCP timeout in seconds. 0 = default for the particular kind of device.

Returns the value contained in the SettingIPConfig:dhcpTimeout property.

Since: 1.2

getDns

settingIPConfigGetDns

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Int32

idx: index number of the DNS server to return

-> m Text

Returns: the IP address of the DNS server at index idx

No description available in the introspection data.

getDnsOption

settingIPConfigGetDnsOption

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Word32

idx: index number of the DNS option

-> m Text

Returns: the DNS option at index idx

Since 1.46, access at index "len" is allowed and returns NULL.

Since: 1.2

getDnsPriority

settingIPConfigGetDnsPriority

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Int32

Returns: the priority of DNS servers

No description available in the introspection data.

Since: 1.4

getDnsSearch

settingIPConfigGetDnsSearch

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Int32

idx: index number of the DNS search domain to return

-> m Text

Returns: the DNS search domain at index idx

Since 1.46, access at index "len" is allowed and returns NULL.

getGateway

settingIPConfigGetGateway

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Text

Returns: the IP address of the gateway associated with this configuration, or Nothing.

No description available in the introspection data.

getIgnoreAutoDns

settingIPConfigGetIgnoreAutoDns

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Bool

Returns: True if automatically configured (ie via DHCP) DNS information should be ignored.

Returns the value contained in the SettingIPConfig:ignoreAutoDns property.

getIgnoreAutoRoutes

settingIPConfigGetIgnoreAutoRoutes

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Bool

Returns: True if automatically configured (ie via DHCP) routes should be ignored.

Returns the value contained in the SettingIPConfig:ignoreAutoRoutes property.

getMayFail

settingIPConfigGetMayFail

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Bool

Returns: True if this connection doesn't require this type of IP addressing to complete for the connection to succeed.

Returns the value contained in the SettingIPConfig:mayFail property.

getMethod

settingIPConfigGetMethod

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Text

Returns: the SettingIPConfig:method property of the setting; see SettingIP4Config and SettingIP6Config for details of the methods available with each type.

No description available in the introspection data.

getNeverDefault

settingIPConfigGetNeverDefault

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Bool

Returns: True if this connection should never be the default connection

Returns the value contained in the SettingIPConfig:neverDefault property.

getNumAddresses

settingIPConfigGetNumAddresses

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Word32

Returns: the number of configured addresses

No description available in the introspection data.

getNumDns

settingIPConfigGetNumDns

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Word32

Returns: the number of configured DNS servers

No description available in the introspection data.

getNumDnsOptions

settingIPConfigGetNumDnsOptions

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Word32

Returns: the number of configured DNS options

No description available in the introspection data.

Since: 1.2

getNumDnsSearches

settingIPConfigGetNumDnsSearches

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Word32

Returns: the number of configured DNS search domains

No description available in the introspection data.

getNumRoutes

settingIPConfigGetNumRoutes

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Word32

Returns: the number of configured routes

No description available in the introspection data.

getNumRoutingRules

settingIPConfigGetNumRoutingRules

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Word32

Returns: the number of configured routing rules

No description available in the introspection data.

Since: 1.18

getReplaceLocalRule

settingIPConfigGetReplaceLocalRule

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Ternary

Returns: the SettingIPConfig:replaceLocalRule property of the setting

No description available in the introspection data.

Since: 1.44

getRequiredTimeout

settingIPConfigGetRequiredTimeout

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Int32

Returns: the required timeout for the address family

Returns the value contained in the SettingIPConfig:requiredTimeout property.

Since: 1.34

getRoute

settingIPConfigGetRoute

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Int32

idx: index number of the route to return

-> m IPRoute

Returns: the route at index idx

No description available in the introspection data.

getRouteMetric

settingIPConfigGetRouteMetric

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Int64

Returns: the route metric that is used for routes that don't explicitly specify a metric. See SettingIPConfig:routeMetric for more details.

Returns the value contained in the SettingIPConfig:routeMetric property.

getRouteTable

settingIPConfigGetRouteTable

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Word32

Returns: the configured route-table.

Returns the value contained in the SettingIPConfig:routeTable property.

Since: 1.10

getRoutingRule

settingIPConfigGetRoutingRule

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Word32

idx: index number of the routing_rule to return

-> m IPRoutingRule

Returns: the routing rule at index idx

No description available in the introspection data.

Since: 1.18

hasDnsOptions

settingIPConfigHasDnsOptions

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> m Bool

Returns: whether DNS options are initialized or left unset (the default).

NMSettingIPConfig can have a list of dns-options. If the list is empty, there are two similar (but differentiated) states. Either the options are explicitly set to have no values, or the options are left undefined. The latter means to use a default configuration, while the former explicitly means "no-options".

Since: 1.2

removeAddress

settingIPConfigRemoveAddress

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Int32

idx: index number of the address to remove

-> m ()

Removes the address at index idx.

removeAddressByValue

settingIPConfigRemoveAddressByValue

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> IPAddress

address: the IP address to remove

-> m Bool

Returns: True if the address was found and removed; False if it was not.

Removes the address address.

removeDhcpRejectServer

settingIPConfigRemoveDhcpRejectServer

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Word32

idx: index number of the DHCP reject server

-> m ()

Removes the DHCP reject server at index idx.

Since: 1.28

removeDns

settingIPConfigRemoveDns

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Int32

idx: index number of the DNS server to remove

-> m ()

Removes the DNS server at index idx.

removeDnsByValue

settingIPConfigRemoveDnsByValue

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Text

dns: the DNS server to remove

-> m Bool

Returns: True if the DNS server was found and removed; False if it was not.

Before 1.42, setting dns to an invalid string was treated as user-error.

Removes the DNS server dns.

removeDnsOption

settingIPConfigRemoveDnsOption

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Int32

idx: index number of the DNS option

-> m ()

Removes the DNS option at index idx.

Since: 1.2

removeDnsOptionByValue

settingIPConfigRemoveDnsOptionByValue

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Text

dnsOption: the DNS option to remove

-> m Bool

Returns: True if the DNS option was found and removed; False if it was not.

Removes the DNS option dnsOption.

Since: 1.2

removeDnsSearch

settingIPConfigRemoveDnsSearch

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Int32

idx: index number of the DNS search domain

-> m ()

Removes the DNS search domain at index idx.

removeDnsSearchByValue

settingIPConfigRemoveDnsSearchByValue

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Text

dnsSearch: the search domain to remove

-> m Bool

Returns: True if the DNS search domain was found and removed; False if it was not.

Removes the DNS search domain dnsSearch.

removeRoute

settingIPConfigRemoveRoute

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Int32

idx: index number of the route

-> m ()

Removes the route at index idx.

removeRouteByValue

settingIPConfigRemoveRouteByValue

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> IPRoute

route: the route to remove

-> m Bool

Returns: True if the route was found and removed; False if it was not.

Removes the first matching route that matches route. Note that before 1.10, this function would only compare dest/prefix,next_hop,metric and ignore route attributes. Now, route must match exactly.

removeRoutingRule

settingIPConfigRemoveRoutingRule

Arguments

:: (HasCallStack, MonadIO m, IsSettingIPConfig a)

=> a

setting: the SettingIPConfig

-> Word32

idx: index number of the routing_rule

-> m ()

Removes the routing_rule at index idx.

Since: 1.18

Properties

addresses

autoRouteExtGw

VPN connections will default to add the route automatically unless this setting is set to False.

For other connection types, adding such an automatic route is currently not supported and setting this to True has no effect.

Since: 1.42

constructSettingIPConfigAutoRouteExtGw :: (IsSettingIPConfig o, MonadIO m) => Ternary -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “auto-route-ext-gw” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigAutoRouteExtGw :: (MonadIO m, IsSettingIPConfig o) => o -> m Ternary

Get the value of the “auto-route-ext-gw” property. When overloading is enabled, this is equivalent to

get settingIPConfig #autoRouteExtGw

setSettingIPConfigAutoRouteExtGw :: (MonadIO m, IsSettingIPConfig o) => o -> Ternary -> m ()

Set the value of the “auto-route-ext-gw” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #autoRouteExtGw := value ]

dadTimeout

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.

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.

Since: 1.2

constructSettingIPConfigDadTimeout :: (IsSettingIPConfig o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “dad-timeout” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigDadTimeout :: (MonadIO m, IsSettingIPConfig o) => o -> m Int32

Get the value of the “dad-timeout” property. When overloading is enabled, this is equivalent to

get settingIPConfig #dadTimeout

setSettingIPConfigDadTimeout :: (MonadIO m, IsSettingIPConfig o) => o -> Int32 -> m ()

Set the value of the “dad-timeout” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #dadTimeout := value ]

dhcpDscp

Specifies the value for the DSCP field (traffic class) of the IP header. When empty, the global default value is used; if no global default is specified, it is assumed to be "CS0". Allowed values are: "CS0", "CS4" and "CS6".

The property is currently valid only for IPv4, and it is supported only by the "internal" DHCP plugin.

Since: 1.46

clearSettingIPConfigDhcpDscp :: (MonadIO m, IsSettingIPConfig o) => o -> m ()

Set the value of the “dhcp-dscp” property to Nothing. When overloading is enabled, this is equivalent to

clear #dhcpDscp

constructSettingIPConfigDhcpDscp :: (IsSettingIPConfig o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “dhcp-dscp” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigDhcpDscp :: (MonadIO m, IsSettingIPConfig o) => o -> m Text

Get the value of the “dhcp-dscp” property. When overloading is enabled, this is equivalent to

get settingIPConfig #dhcpDscp

setSettingIPConfigDhcpDscp :: (MonadIO m, IsSettingIPConfig o) => o -> Text -> m ()

Set the value of the “dhcp-dscp” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #dhcpDscp := value ]

dhcpHostname

If the SettingIPConfig:dhcpSendHostname property is True, then the specified name will be sent to the DHCP server when acquiring a lease. This property and SettingIP4Config:dhcpFqdn are mutually exclusive and cannot be set at the same time.

clearSettingIPConfigDhcpHostname :: (MonadIO m, IsSettingIPConfig o) => o -> m ()

Set the value of the “dhcp-hostname” property to Nothing. When overloading is enabled, this is equivalent to

clear #dhcpHostname

constructSettingIPConfigDhcpHostname :: (IsSettingIPConfig o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “dhcp-hostname” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigDhcpHostname :: (MonadIO m, IsSettingIPConfig o) => o -> m Text

Get the value of the “dhcp-hostname” property. When overloading is enabled, this is equivalent to

get settingIPConfig #dhcpHostname

setSettingIPConfigDhcpHostname :: (MonadIO m, IsSettingIPConfig o) => o -> Text -> m ()

Set the value of the “dhcp-hostname” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #dhcpHostname := value ]

dhcpHostnameFlags

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 DhcpHostnameFlagsFqdnServUpdate, DhcpHostnameFlagsFqdnEncoded and DhcpHostnameFlagsFqdnNoUpdate. When no FQDN flag is set and DhcpHostnameFlagsFqdnClearFlags is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and DhcpHostnameFlagsFqdnClearFlags is not set, the standard FQDN flags are set in the request: DhcpHostnameFlagsFqdnServUpdate, DhcpHostnameFlagsFqdnEncoded for IPv4 and DhcpHostnameFlagsFqdnServUpdate for IPv6.

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

Since: 1.22

constructSettingIPConfigDhcpHostnameFlags :: (IsSettingIPConfig o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “dhcp-hostname-flags” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigDhcpHostnameFlags :: (MonadIO m, IsSettingIPConfig o) => o -> m Word32

Get the value of the “dhcp-hostname-flags” property. When overloading is enabled, this is equivalent to

get settingIPConfig #dhcpHostnameFlags

setSettingIPConfigDhcpHostnameFlags :: (MonadIO m, IsSettingIPConfig o) => o -> Word32 -> m ()

Set the value of the “dhcp-hostname-flags” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #dhcpHostnameFlags := value ]

dhcpIaid

A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "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".

For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id.

For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address.

The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.

Since: 1.22

clearSettingIPConfigDhcpIaid :: (MonadIO m, IsSettingIPConfig o) => o -> m ()

Set the value of the “dhcp-iaid” property to Nothing. When overloading is enabled, this is equivalent to

clear #dhcpIaid

constructSettingIPConfigDhcpIaid :: (IsSettingIPConfig o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “dhcp-iaid” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigDhcpIaid :: (MonadIO m, IsSettingIPConfig o) => o -> m Text

Get the value of the “dhcp-iaid” property. When overloading is enabled, this is equivalent to

get settingIPConfig #dhcpIaid

setSettingIPConfigDhcpIaid :: (MonadIO m, IsSettingIPConfig o) => o -> Text -> m ()

Set the value of the “dhcp-iaid” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #dhcpIaid := value ]

dhcpRejectServers

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.

Since: 1.28

clearSettingIPConfigDhcpRejectServers :: (MonadIO m, IsSettingIPConfig o) => o -> m ()

Set the value of the “dhcp-reject-servers” property to Nothing. When overloading is enabled, this is equivalent to

clear #dhcpRejectServers

constructSettingIPConfigDhcpRejectServers :: (IsSettingIPConfig o, MonadIO m) => [Text] -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “dhcp-reject-servers” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigDhcpRejectServers :: (MonadIO m, IsSettingIPConfig o) => o -> m (Maybe [Text])

Get the value of the “dhcp-reject-servers” property. When overloading is enabled, this is equivalent to

get settingIPConfig #dhcpRejectServers

setSettingIPConfigDhcpRejectServers :: (MonadIO m, IsSettingIPConfig o) => o -> [Text] -> m ()

Set the value of the “dhcp-reject-servers” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #dhcpRejectServers := value ]

dhcpSendHostname

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 SettingIPConfig:dhcpHostname property is Nothing and this property is True, the current persistent hostname of the computer is sent.

constructSettingIPConfigDhcpSendHostname :: (IsSettingIPConfig o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “dhcp-send-hostname” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigDhcpSendHostname :: (MonadIO m, IsSettingIPConfig o) => o -> m Bool

Get the value of the “dhcp-send-hostname” property. When overloading is enabled, this is equivalent to

get settingIPConfig #dhcpSendHostname

setSettingIPConfigDhcpSendHostname :: (MonadIO m, IsSettingIPConfig o) => o -> Bool -> m ()

Set the value of the “dhcp-send-hostname” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #dhcpSendHostname := value ]

dhcpSendRelease

Whether the DHCP client will send RELEASE message when bringing the connection down. The default value is TernaryDefault. When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as False.

Since: 1.48

constructSettingIPConfigDhcpSendRelease :: (IsSettingIPConfig o, MonadIO m) => Ternary -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “dhcp-send-release” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigDhcpSendRelease :: (MonadIO m, IsSettingIPConfig o) => o -> m Ternary

Get the value of the “dhcp-send-release” property. When overloading is enabled, this is equivalent to

get settingIPConfig #dhcpSendRelease

setSettingIPConfigDhcpSendRelease :: (MonadIO m, IsSettingIPConfig o) => o -> Ternary -> m ()

Set the value of the “dhcp-send-release” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #dhcpSendRelease := value ]

dhcpTimeout

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.

constructSettingIPConfigDhcpTimeout :: (IsSettingIPConfig o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “dhcp-timeout” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigDhcpTimeout :: (MonadIO m, IsSettingIPConfig o) => o -> m Int32

Get the value of the “dhcp-timeout” property. When overloading is enabled, this is equivalent to

get settingIPConfig #dhcpTimeout

setSettingIPConfigDhcpTimeout :: (MonadIO m, IsSettingIPConfig o) => o -> Int32 -> m ()

Set the value of the “dhcp-timeout” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #dhcpTimeout := value ]

dns

Array of IP addresses of DNS servers.

For DoT (DNS over TLS), the SNI server name can be specified by appending "example.com" to the IP address of the DNS server. This currently only has effect when using systemd-resolved.

clearSettingIPConfigDns :: (MonadIO m, IsSettingIPConfig o) => o -> m ()

Set the value of the “dns” property to Nothing. When overloading is enabled, this is equivalent to

clear #dns

constructSettingIPConfigDns :: (IsSettingIPConfig o, MonadIO m) => [Text] -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “dns” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigDns :: (MonadIO m, IsSettingIPConfig o) => o -> m (Maybe [Text])

Get the value of the “dns” property. When overloading is enabled, this is equivalent to

get settingIPConfig #dns

setSettingIPConfigDns :: (MonadIO m, IsSettingIPConfig o) => o -> [Text] -> m ()

Set the value of the “dns” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #dns := value ]

dnsOptions

Array of DNS options to be added to resolv.conf.

Nothing 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 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, unless "_no-add-edns0" and "_no-add-trust-ad" are present.

Since: 1.2

clearSettingIPConfigDnsOptions :: (MonadIO m, IsSettingIPConfig o) => o -> m ()

Set the value of the “dns-options” property to Nothing. When overloading is enabled, this is equivalent to

clear #dnsOptions

constructSettingIPConfigDnsOptions :: (IsSettingIPConfig o, MonadIO m) => [Text] -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “dns-options” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigDnsOptions :: (MonadIO m, IsSettingIPConfig o) => o -> m (Maybe [Text])

Get the value of the “dns-options” property. When overloading is enabled, this is equivalent to

get settingIPConfig #dnsOptions

setSettingIPConfigDnsOptions :: (MonadIO m, IsSettingIPConfig o) => o -> [Text] -> m ()

Set the value of the “dns-options” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #dnsOptions := value ]

dnsPriority

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.

Since: 1.4

constructSettingIPConfigDnsPriority :: (IsSettingIPConfig o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “dns-priority” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigDnsPriority :: (MonadIO m, IsSettingIPConfig o) => o -> m Int32

Get the value of the “dns-priority” property. When overloading is enabled, this is equivalent to

get settingIPConfig #dnsPriority

setSettingIPConfigDnsPriority :: (MonadIO m, IsSettingIPConfig o) => o -> Int32 -> m ()

Set the value of the “dns-priority” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #dnsPriority := value ]

dnsSearch

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

When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).

clearSettingIPConfigDnsSearch :: (MonadIO m, IsSettingIPConfig o) => o -> m ()

Set the value of the “dns-search” property to Nothing. When overloading is enabled, this is equivalent to

clear #dnsSearch

constructSettingIPConfigDnsSearch :: (IsSettingIPConfig o, MonadIO m) => [Text] -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “dns-search” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigDnsSearch :: (MonadIO m, IsSettingIPConfig o) => o -> m (Maybe [Text])

Get the value of the “dns-search” property. When overloading is enabled, this is equivalent to

get settingIPConfig #dnsSearch

setSettingIPConfigDnsSearch :: (MonadIO m, IsSettingIPConfig o) => o -> [Text] -> m ()

Set the value of the “dns-search” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #dnsSearch := value ]

gateway

The gateway associated with this configuration. This is only meaningful if SettingIPConfig:addresses is also set.

Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if SettingIPConfig:neverDefault is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.

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 SettingWireGuard:ip4AutoDefaultRoute.

clearSettingIPConfigGateway :: (MonadIO m, IsSettingIPConfig o) => o -> m ()

Set the value of the “gateway” property to Nothing. When overloading is enabled, this is equivalent to

clear #gateway

constructSettingIPConfigGateway :: (IsSettingIPConfig o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gateway” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigGateway :: (MonadIO m, IsSettingIPConfig o) => o -> m Text

Get the value of the “gateway” property. When overloading is enabled, this is equivalent to

get settingIPConfig #gateway

setSettingIPConfigGateway :: (MonadIO m, IsSettingIPConfig o) => o -> Text -> m ()

Set the value of the “gateway” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #gateway := value ]

ignoreAutoDns

When SettingIPConfig: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 SettingIPConfig:dns and SettingIPConfig:dnsSearch properties, if any, are used.

constructSettingIPConfigIgnoreAutoDns :: (IsSettingIPConfig o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “ignore-auto-dns” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigIgnoreAutoDns :: (MonadIO m, IsSettingIPConfig o) => o -> m Bool

Get the value of the “ignore-auto-dns” property. When overloading is enabled, this is equivalent to

get settingIPConfig #ignoreAutoDns

setSettingIPConfigIgnoreAutoDns :: (MonadIO m, IsSettingIPConfig o) => o -> Bool -> m ()

Set the value of the “ignore-auto-dns” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #ignoreAutoDns := value ]

ignoreAutoRoutes

When SettingIPConfig:method is set to "auto" and this property to True, automatically configured routes are ignored and only routes specified in the SettingIPConfig:routes property, if any, are used.

constructSettingIPConfigIgnoreAutoRoutes :: (IsSettingIPConfig o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “ignore-auto-routes” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigIgnoreAutoRoutes :: (MonadIO m, IsSettingIPConfig o) => o -> m Bool

Get the value of the “ignore-auto-routes” property. When overloading is enabled, this is equivalent to

get settingIPConfig #ignoreAutoRoutes

setSettingIPConfigIgnoreAutoRoutes :: (MonadIO m, IsSettingIPConfig o) => o -> Bool -> m ()

Set the value of the “ignore-auto-routes” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #ignoreAutoRoutes := value ]

mayFail

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 SettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.

constructSettingIPConfigMayFail :: (IsSettingIPConfig o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “may-fail” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigMayFail :: (MonadIO m, IsSettingIPConfig o) => o -> m Bool

Get the value of the “may-fail” property. When overloading is enabled, this is equivalent to

get settingIPConfig #mayFail

setSettingIPConfigMayFail :: (MonadIO m, IsSettingIPConfig o) => o -> Bool -> m ()

Set the value of the “may-fail” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #mayFail := value ]

method

IP configuration method.

SettingIP4Config and SettingIP6Config 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 SettingIPConfig:dns and SettingIPConfig:routes specify information that is added on to the information returned from automatic configuration. The SettingIPConfig:ignoreAutoRoutes and SettingIPConfig:ignoreAutoDns 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.

clearSettingIPConfigMethod :: (MonadIO m, IsSettingIPConfig o) => o -> m ()

Set the value of the “method” property to Nothing. When overloading is enabled, this is equivalent to

clear #method

constructSettingIPConfigMethod :: (IsSettingIPConfig o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “method” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigMethod :: (MonadIO m, IsSettingIPConfig o) => o -> m Text

Get the value of the “method” property. When overloading is enabled, this is equivalent to

get settingIPConfig #method

setSettingIPConfigMethod :: (MonadIO m, IsSettingIPConfig o) => o -> Text -> m ()

Set the value of the “method” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #method := value ]

neverDefault

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.

constructSettingIPConfigNeverDefault :: (IsSettingIPConfig o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “never-default” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigNeverDefault :: (MonadIO m, IsSettingIPConfig o) => o -> m Bool

Get the value of the “never-default” property. When overloading is enabled, this is equivalent to

get settingIPConfig #neverDefault

setSettingIPConfigNeverDefault :: (MonadIO m, IsSettingIPConfig o) => o -> Bool -> m ()

Set the value of the “never-default” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #neverDefault := value ]

replaceLocalRule

Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to True.

Since: 1.44

constructSettingIPConfigReplaceLocalRule :: (IsSettingIPConfig o, MonadIO m) => Ternary -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “replace-local-rule” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigReplaceLocalRule :: (MonadIO m, IsSettingIPConfig o) => o -> m Ternary

Get the value of the “replace-local-rule” property. When overloading is enabled, this is equivalent to

get settingIPConfig #replaceLocalRule

setSettingIPConfigReplaceLocalRule :: (MonadIO m, IsSettingIPConfig o) => o -> Ternary -> m ()

Set the value of the “replace-local-rule” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #replaceLocalRule := value ]

requiredTimeout

The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.

This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.

Note that if SettingIPConfig:mayFail is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.

A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).

Since: 1.34

constructSettingIPConfigRequiredTimeout :: (IsSettingIPConfig o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “required-timeout” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigRequiredTimeout :: (MonadIO m, IsSettingIPConfig o) => o -> m Int32

Get the value of the “required-timeout” property. When overloading is enabled, this is equivalent to

get settingIPConfig #requiredTimeout

setSettingIPConfigRequiredTimeout :: (MonadIO m, IsSettingIPConfig o) => o -> Int32 -> m ()

Set the value of the “required-timeout” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #requiredTimeout := value ]

routeMetric

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.

constructSettingIPConfigRouteMetric :: (IsSettingIPConfig o, MonadIO m) => Int64 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “route-metric” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigRouteMetric :: (MonadIO m, IsSettingIPConfig o) => o -> m Int64

Get the value of the “route-metric” property. When overloading is enabled, this is equivalent to

get settingIPConfig #routeMetric

setSettingIPConfigRouteMetric :: (MonadIO m, IsSettingIPConfig o) => o -> Int64 -> m ()

Set the value of the “route-metric” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #routeMetric := value ]

routeTable

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.

Since: 1.10

constructSettingIPConfigRouteTable :: (IsSettingIPConfig o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “route-table” property. This is rarely needed directly, but it is used by new.

getSettingIPConfigRouteTable :: (MonadIO m, IsSettingIPConfig o) => o -> m Word32

Get the value of the “route-table” property. When overloading is enabled, this is equivalent to

get settingIPConfig #routeTable

setSettingIPConfigRouteTable :: (MonadIO m, IsSettingIPConfig o) => o -> Word32 -> m ()

Set the value of the “route-table” property. When overloading is enabled, this is equivalent to

set settingIPConfig [ #routeTable := value ]

routes