GI.NM.Objects.SettingWireless

Wi-Fi Settings

Exported types

newtype SettingWireless

Memory-managed wrapper type.

Constructors

SettingWireless (ManagedPtr SettingWireless)

Instances

Eq SettingWireless

Defined in GI.NM.Objects.SettingWireless

Methods

(==) :: SettingWireless -> SettingWireless -> Bool

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

GObject SettingWireless

Defined in GI.NM.Objects.SettingWireless

ManagedPtrNewtype SettingWireless

Defined in GI.NM.Objects.SettingWireless

Methods

toManagedPtr :: SettingWireless -> ManagedPtr SettingWireless

TypedObject SettingWireless

Defined in GI.NM.Objects.SettingWireless

Methods

glibType :: IO GType

HasParentTypes SettingWireless

Defined in GI.NM.Objects.SettingWireless

IsGValue (Maybe SettingWireless)

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

Defined in GI.NM.Objects.SettingWireless

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes SettingWireless

Defined in GI.NM.Objects.SettingWireless

type ParentTypes SettingWireless = '[Setting, Object]

class (GObject o, IsDescendantOf SettingWireless o) => IsSettingWireless o

Type class for types which can be safely cast to SettingWireless, for instance with toSettingWireless.

Instances

(GObject o, IsDescendantOf SettingWireless o) => IsSettingWireless o

Defined in GI.NM.Objects.SettingWireless

toSettingWireless :: (MonadIO m, IsSettingWireless o) => o -> m SettingWireless

Cast to SettingWireless, 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

addMacBlacklistItem, addMacDenylistItem, addSeenBssid, apSecurityCompatible, bindProperty, bindPropertyFull, clearMacBlacklistItems, clearMacDenylistItems, compare, diff, duplicate, enumerateValues, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, optionClearByName, optionGet, optionGetAllNames, optionGetBoolean, optionGetUint32, optionSet, optionSetBoolean, optionSetUint32, ref, refSink, removeMacBlacklistItem, removeMacBlacklistItemByValue, removeMacDenylistItem, removeMacDenylistItemByValue, runDispose, stealData, stealQdata, thawNotify, toString, unref, verify, verifySecrets, watchClosure.

Getters

getApIsolation, getBand, getBssid, getChannel, getChannelWidth, getClonedMacAddress, getData, getDbusPropertyType, getGenerateMacAddressMask, getHidden, getMacAddress, getMacAddressBlacklist, getMacAddressDenylist, getMacAddressRandomization, getMacBlacklistItem, getMacDenylistItem, getMode, getMtu, getName, getNumMacBlacklistItems, getNumMacDenylistItems, getNumSeenBssids, getPowersave, getProperty, getQdata, getRate, getSecretFlags, getSeenBssid, getSsid, getTxPower, getWakeOnWlan.

Setters

setData, setDataFull, setProperty, setSecretFlags.

addMacBlacklistItem

settingWirelessAddMacBlacklistItem

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> Text

mac: the MAC address string (hex-digits-and-colons notation) to denylist

-> m Bool

Returns: True if the MAC address was added; False if the MAC address is invalid or was already present

Deprecated: (Since version 1.48.)Use settingWirelessAddMacDenylistItem instead.

Adds a new MAC address to the SettingWireless:macAddressDenylist property.

addMacDenylistItem

settingWirelessAddMacDenylistItem

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> Text

mac: the MAC address string (hex-digits-and-colons notation) to denylist

-> m Bool

Returns: True if the MAC address was added; False if the MAC address is invalid or was already present

Adds a new MAC address to the SettingWireless:macAddressDenylist property.

Since: 1.48

addSeenBssid

settingWirelessAddSeenBssid

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> Text

bssid: the new BSSID to add to the list

-> m Bool

Returns: True if bssid was already known, False if not

Adds a new Wi-Fi AP's BSSID to the previously seen BSSID list of the setting. NetworkManager now tracks previously seen BSSIDs internally so this function no longer has much use. Actually, changes you make using this function will not be preserved.

apSecurityCompatible

settingWirelessApSecurityCompatible

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a, IsSettingWirelessSecurity b)

=> a

sWireless: a SettingWireless

-> b

sWirelessSec: a SettingWirelessSecurity or Nothing

-> [NM80211ApFlags]

apFlags: the NM80211ApFlags of the given access point

-> [NM80211ApSecurityFlags]

apWpa: the NM80211ApSecurityFlags of the given access point's WPA capabilities

-> [NM80211ApSecurityFlags]

apRsn: the NM80211ApSecurityFlags of the given access point's WPA2/RSN capabilities

-> NM80211Mode

apMode: the 802.11 mode of the AP, either Ad-Hoc or Infrastructure

-> m Bool

Returns: True if the given settings are compatible with the access point's security flags and mode, False if they are not.

Given a SettingWireless and an optional SettingWirelessSecurity, determine if the configuration given by the settings is compatible with the security of an access point using that access point's capability flags and mode. Useful for clients that wish to filter a set of connections against a set of access points and determine which connections are compatible with which access points.

clearMacBlacklistItems

settingWirelessClearMacBlacklistItems

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m ()

Deprecated: (Since version 1.48.)Use settingWirelessClearMacDenylistItems instead.

Removes all denylisted MAC addresses.

clearMacDenylistItems

settingWirelessClearMacDenylistItems

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m ()

Removes all denylisted MAC addresses.

Since: 1.48

getApIsolation

settingWirelessGetApIsolation

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m Ternary

Returns: the SettingWireless:apIsolation property of the setting

No description available in the introspection data.

Since: 1.28

getBand

settingWirelessGetBand

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m Text

Returns: the SettingWireless:band property of the setting

No description available in the introspection data.

getBssid

settingWirelessGetBssid

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m Text

Returns: the SettingWireless:bssid property of the setting

No description available in the introspection data.

getChannel

settingWirelessGetChannel

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m Word32

Returns: the SettingWireless:channel property of the setting

No description available in the introspection data.

getChannelWidth

settingWirelessGetChannelWidth

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m SettingWirelessChannelWidth

Returns: the channel width

Returns the SettingWireless:channelWidth property.

Since: 1.50

getClonedMacAddress

settingWirelessGetClonedMacAddress

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m Text

Returns: the SettingWireless:clonedMacAddress property of the setting

No description available in the introspection data.

getGenerateMacAddressMask

settingWirelessGetGenerateMacAddressMask

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m Text

Returns: the SettingWireless:generateMacAddressMask property of the setting

No description available in the introspection data.

Since: 1.4

getHidden

settingWirelessGetHidden

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m Bool

Returns: the SettingWireless:hidden property of the setting

No description available in the introspection data.

getMacAddress

settingWirelessGetMacAddress

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m Text

Returns: the SettingWireless:macAddress property of the setting

No description available in the introspection data.

getMacAddressBlacklist

settingWirelessGetMacAddressBlacklist

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m [Text]

Returns: the SettingWireless:macAddressBlacklist property of the setting

Deprecated: (Since version 1.48.)Use settingWirelessGetMacAddressDenylist instead.

No description available in the introspection data.

getMacAddressDenylist

settingWirelessGetMacAddressDenylist

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m [Text]

Returns: the SettingWireless:macAddressDenylist property of the setting

No description available in the introspection data.

Since: 1.48

getMacAddressRandomization

settingWirelessGetMacAddressRandomization

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m SettingMacRandomization

Returns: the SettingWireless:macAddressRandomization property of the setting

No description available in the introspection data.

Since: 1.2

getMacBlacklistItem

settingWirelessGetMacBlacklistItem

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> Word32

idx: the zero-based index of the MAC address entry

-> m Text

Returns: the denylisted MAC address string (hex-digits-and-colons notation) at index idx

Deprecated: (Since version 1.48.)Use settingWirelessGetMacDenylistItem instead.

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

getMacDenylistItem

settingWirelessGetMacDenylistItem

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> Word32

idx: the zero-based index of the MAC address entry

-> m Text

Returns: the denylisted MAC address string (hex-digits-and-colons notation) at index idx

No description available in the introspection data.

Since: 1.48

getMode

settingWirelessGetMode

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m Text

Returns: the SettingWireless:mode property of the setting

No description available in the introspection data.

getMtu

settingWirelessGetMtu

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m Word32

Returns: the SettingWireless:mtu property of the setting

No description available in the introspection data.

getNumMacBlacklistItems

settingWirelessGetNumMacBlacklistItems

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m Word32

Returns: the number of blacklist MAC addresses

Deprecated: (Since version 1.48.)Use settingWirelessGetNumMacDenylistItems instead.

No description available in the introspection data.

getNumMacDenylistItems

settingWirelessGetNumMacDenylistItems

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m Word32

Returns: the number of denylisted MAC addresses

No description available in the introspection data.

Since: 1.48

getNumSeenBssids

settingWirelessGetNumSeenBssids

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m Word32

Returns: the number of BSSIDs in the previously seen BSSID list

No description available in the introspection data.

getPowersave

settingWirelessGetPowersave

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m Word32

Returns: the SettingWireless:powersave property of the setting

No description available in the introspection data.

Since: 1.2

getRate

settingWirelessGetRate

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m Word32

Returns: the SettingWireless:rate property of the setting

Deprecated: (Since version 1.44)This setting is not implemented and has no effect.

No description available in the introspection data.

getSeenBssid

settingWirelessGetSeenBssid

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> Word32

i: index of a BSSID in the previously seen BSSID list

-> m Text

Returns: the BSSID at index i

No description available in the introspection data.

getSsid

settingWirelessGetSsid

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m Bytes

Returns: the SettingWireless:ssid property of the setting

No description available in the introspection data.

getTxPower

settingWirelessGetTxPower

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m Word32

Returns: the SettingWireless:txPower property of the setting

Deprecated: (Since version 1.44)This setting is not implemented and has no effect.

No description available in the introspection data.

getWakeOnWlan

settingWirelessGetWakeOnWlan

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> m [SettingWirelessWakeOnWLan]

Returns: the Wake-on-WLAN options

Returns the Wake-on-WLAN options enabled for the connection

Since: 1.12

new

settingWirelessNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SettingWireless

Returns: the new empty SettingWireless object

Creates a new SettingWireless object with default values.

removeMacBlacklistItem

settingWirelessRemoveMacBlacklistItem

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> Word32

idx: index number of the MAC address

-> m ()

Deprecated: (Since version 1.48.)Use settingWirelessRemoveMacDenylistItem instead.

Removes the MAC address at index idx from the denylist.

removeMacBlacklistItemByValue

settingWirelessRemoveMacBlacklistItemByValue

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> Text

mac: the MAC address string (hex-digits-and-colons notation) to remove from the denylist

-> m Bool

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

Deprecated: (Since version 1.48.)Use settingWirelessRemoveMacDenylistItemByValue instead.

Removes the MAC address mac from the denylist.

removeMacDenylistItem

settingWirelessRemoveMacDenylistItem

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> Word32

idx: index number of the MAC address

-> m ()

Removes the MAC address at index idx from the denylist.

Since: 1.48

removeMacDenylistItemByValue

settingWirelessRemoveMacDenylistItemByValue

Arguments

:: (HasCallStack, MonadIO m, IsSettingWireless a)

=> a

setting: the SettingWireless

-> Text

mac: the MAC address string (hex-digits-and-colons notation) to remove from the denylist

-> m Bool

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

Removes the MAC address mac from the denylist.

Since: 1.48

Properties

apIsolation

Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from TernaryDefault only when the interface is configured in AP mode.

If set to TernaryTrue, devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc.

If set to TernaryFalse, devices can talk to each other.

When set to TernaryDefault, the global default is used; in case the global default is unspecified it is assumed to be TernaryFalse.

Since: 1.28

constructSettingWirelessApIsolation :: (IsSettingWireless o, MonadIO m) => Ternary -> m (GValueConstruct o)

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

getSettingWirelessApIsolation :: (MonadIO m, IsSettingWireless o) => o -> m Ternary

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

get settingWireless #apIsolation

setSettingWirelessApIsolation :: (MonadIO m, IsSettingWireless o) => o -> Ternary -> m ()

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

set settingWireless [ #apIsolation := value ]

band

802. 11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.

clearSettingWirelessBand :: (MonadIO m, IsSettingWireless o) => o -> m ()

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

clear #band

constructSettingWirelessBand :: (IsSettingWireless o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingWirelessBand :: (MonadIO m, IsSettingWireless o) => o -> m Text

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

get settingWireless #band

setSettingWirelessBand :: (MonadIO m, IsSettingWireless o) => o -> Text -> m ()

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

set settingWireless [ #band := value ]

bssid

If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.

Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.

clearSettingWirelessBssid :: (MonadIO m, IsSettingWireless o) => o -> m ()

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

clear #bssid

constructSettingWirelessBssid :: (IsSettingWireless o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingWirelessBssid :: (MonadIO m, IsSettingWireless o) => o -> m Text

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

get settingWireless #bssid

setSettingWirelessBssid :: (MonadIO m, IsSettingWireless o) => o -> Text -> m ()

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

set settingWireless [ #bssid := value ]

channel

Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.

constructSettingWirelessChannel :: (IsSettingWireless o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingWirelessChannel :: (MonadIO m, IsSettingWireless o) => o -> m Word32

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

get settingWireless #channel

setSettingWirelessChannel :: (MonadIO m, IsSettingWireless o) => o -> Word32 -> m ()

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

set settingWireless [ #channel := value ]

channelWidth

Specifies width of the wireless channel in Access Point (AP) mode.

When set to SettingWirelessChannelWidthAuto (the default), the channel width is automatically determined. At the moment, this means that the safest (smallest) width is chosen.

If the value is not SettingWirelessChannelWidthAuto, then the 'channel' property must also be set. When using the 2.4GHz band, the width can be at most 40MHz.

This property can be set to a value different from SettingWirelessChannelWidthAuto only when the interface is configured in AP mode.

Since: 1.50

constructSettingWirelessChannelWidth :: (IsSettingWireless o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getSettingWirelessChannelWidth :: (MonadIO m, IsSettingWireless o) => o -> m Int32

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

get settingWireless #channelWidth

setSettingWirelessChannelWidth :: (MonadIO m, IsSettingWireless o) => o -> Int32 -> m ()

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

set settingWireless [ #channelWidth := value ]

clonedMacAddress

If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.

Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random", "stable" and "stable-ssid" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address of the device. "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key. "stable-ssid" creates a hashed MAC address based on the SSID, the same as setting the stable-id to "${NETWORK_SSID}".

If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).

On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".

clearSettingWirelessClonedMacAddress :: (MonadIO m, IsSettingWireless o) => o -> m ()

Set the value of the “cloned-mac-address” property to Nothing. When overloading is enabled, this is equivalent to

clear #clonedMacAddress

constructSettingWirelessClonedMacAddress :: (IsSettingWireless o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingWirelessClonedMacAddress :: (MonadIO m, IsSettingWireless o) => o -> m Text

Get the value of the “cloned-mac-address” property. When overloading is enabled, this is equivalent to

get settingWireless #clonedMacAddress

setSettingWirelessClonedMacAddress :: (MonadIO m, IsSettingWireless o) => o -> Text -> m ()

Set the value of the “cloned-mac-address” property. When overloading is enabled, this is equivalent to

set settingWireless [ #clonedMacAddress := value ]

generateMacAddressMask

With SettingWireless:clonedMacAddress setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.

If the property is Nothing, it is eligible to be overwritten by a default connection setting. If the value is still Nothing or an empty string, the default is to create a locally-administered, unicast MAC address.

If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm.

If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address.

If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.

clearSettingWirelessGenerateMacAddressMask :: (MonadIO m, IsSettingWireless o) => o -> m ()

Set the value of the “generate-mac-address-mask” property to Nothing. When overloading is enabled, this is equivalent to

clear #generateMacAddressMask

constructSettingWirelessGenerateMacAddressMask :: (IsSettingWireless o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingWirelessGenerateMacAddressMask :: (MonadIO m, IsSettingWireless o) => o -> m Text

Get the value of the “generate-mac-address-mask” property. When overloading is enabled, this is equivalent to

get settingWireless #generateMacAddressMask

setSettingWirelessGenerateMacAddressMask :: (MonadIO m, IsSettingWireless o) => o -> Text -> m ()

Set the value of the “generate-mac-address-mask” property. When overloading is enabled, this is equivalent to

set settingWireless [ #generateMacAddressMask := value ]

hidden

If True, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode.

In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.

In AP mode, the created network does not broadcast its SSID.

Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.

constructSettingWirelessHidden :: (IsSettingWireless o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getSettingWirelessHidden :: (MonadIO m, IsSettingWireless o) => o -> m Bool

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

get settingWireless #hidden

setSettingWirelessHidden :: (MonadIO m, IsSettingWireless o) => o -> Bool -> m ()

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

set settingWireless [ #hidden := value ]

macAddress

If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).

clearSettingWirelessMacAddress :: (MonadIO m, IsSettingWireless o) => o -> m ()

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

clear #macAddress

constructSettingWirelessMacAddress :: (IsSettingWireless o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingWirelessMacAddress :: (MonadIO m, IsSettingWireless o) => o -> m Text

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

get settingWireless #macAddress

setSettingWirelessMacAddress :: (MonadIO m, IsSettingWireless o) => o -> Text -> m ()

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

set settingWireless [ #macAddress := value ]

macAddressBlacklist

A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").

clearSettingWirelessMacAddressBlacklist :: (MonadIO m, IsSettingWireless o) => o -> m ()

Set the value of the “mac-address-blacklist” property to Nothing. When overloading is enabled, this is equivalent to

clear #macAddressBlacklist

constructSettingWirelessMacAddressBlacklist :: (IsSettingWireless o, MonadIO m) => [Text] -> m (GValueConstruct o)

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

getSettingWirelessMacAddressBlacklist :: (MonadIO m, IsSettingWireless o) => o -> m [Text]

Get the value of the “mac-address-blacklist” property. When overloading is enabled, this is equivalent to

get settingWireless #macAddressBlacklist

setSettingWirelessMacAddressBlacklist :: (MonadIO m, IsSettingWireless o) => o -> [Text] -> m ()

Set the value of the “mac-address-blacklist” property. When overloading is enabled, this is equivalent to

set settingWireless [ #macAddressBlacklist := value ]

macAddressDenylist

A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").

clearSettingWirelessMacAddressDenylist :: (MonadIO m, IsSettingWireless o) => o -> m ()

Set the value of the “mac-address-denylist” property to Nothing. When overloading is enabled, this is equivalent to

clear #macAddressDenylist

constructSettingWirelessMacAddressDenylist :: (IsSettingWireless o, MonadIO m) => [Text] -> m (GValueConstruct o)

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

getSettingWirelessMacAddressDenylist :: (MonadIO m, IsSettingWireless o) => o -> m [Text]

Get the value of the “mac-address-denylist” property. When overloading is enabled, this is equivalent to

get settingWireless #macAddressDenylist

setSettingWirelessMacAddressDenylist :: (MonadIO m, IsSettingWireless o) => o -> [Text] -> m ()

Set the value of the “mac-address-denylist” property. When overloading is enabled, this is equivalent to

set settingWireless [ #macAddressDenylist := value ]

macAddressRandomization

One of SettingMacRandomizationDefault (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), SettingMacRandomizationNever (never randomize the MAC address), or SettingMacRandomizationAlways (always randomize the MAC address).

Since: 1.2

constructSettingWirelessMacAddressRandomization :: (IsSettingWireless o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingWirelessMacAddressRandomization :: (MonadIO m, IsSettingWireless o) => o -> m Word32

Get the value of the “mac-address-randomization” property. When overloading is enabled, this is equivalent to

get settingWireless #macAddressRandomization

setSettingWirelessMacAddressRandomization :: (MonadIO m, IsSettingWireless o) => o -> Word32 -> m ()

Set the value of the “mac-address-randomization” property. When overloading is enabled, this is equivalent to

set settingWireless [ #macAddressRandomization := value ]

mode

Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.

clearSettingWirelessMode :: (MonadIO m, IsSettingWireless o) => o -> m ()

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

clear #mode

constructSettingWirelessMode :: (IsSettingWireless o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingWirelessMode :: (MonadIO m, IsSettingWireless o) => o -> m Text

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

get settingWireless #mode

setSettingWirelessMode :: (MonadIO m, IsSettingWireless o) => o -> Text -> m ()

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

set settingWireless [ #mode := value ]

mtu

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.

constructSettingWirelessMtu :: (IsSettingWireless o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingWirelessMtu :: (MonadIO m, IsSettingWireless o) => o -> m Word32

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

get settingWireless #mtu

setSettingWirelessMtu :: (MonadIO m, IsSettingWireless o) => o -> Word32 -> m ()

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

set settingWireless [ #mtu := value ]

powersave

One of SettingWirelessPowersaveDisable (disable Wi-Fi power saving), SettingWirelessPowersaveEnable (enable Wi-Fi power saving), SettingWirelessPowersaveIgnore (don't touch currently configure setting) or SettingWirelessPowersaveDefault (use the globally configured value). All other values are reserved.

Since: 1.2

constructSettingWirelessPowersave :: (IsSettingWireless o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingWirelessPowersave :: (MonadIO m, IsSettingWireless o) => o -> m Word32

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

get settingWireless #powersave

setSettingWirelessPowersave :: (MonadIO m, IsSettingWireless o) => o -> Word32 -> m ()

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

set settingWireless [ #powersave := value ]

rate

This property is not implemented and has no effect.

constructSettingWirelessRate :: (IsSettingWireless o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingWirelessRate :: (MonadIO m, IsSettingWireless o) => o -> m Word32

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

get settingWireless #rate

setSettingWirelessRate :: (MonadIO m, IsSettingWireless o) => o -> Word32 -> m ()

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

set settingWireless [ #rate := value ]

seenBssids

A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.

This is not a regular property that the user would configure. Instead, NetworkManager automatically sets the seen BSSIDs and tracks them internally in "/var/lib/NetworkManager/seen-bssids" file.

clearSettingWirelessSeenBssids :: (MonadIO m, IsSettingWireless o) => o -> m ()

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

clear #seenBssids

constructSettingWirelessSeenBssids :: (IsSettingWireless o, MonadIO m) => [Text] -> m (GValueConstruct o)

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

getSettingWirelessSeenBssids :: (MonadIO m, IsSettingWireless o) => o -> m (Maybe [Text])

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

get settingWireless #seenBssids

setSettingWirelessSeenBssids :: (MonadIO m, IsSettingWireless o) => o -> [Text] -> m ()

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

set settingWireless [ #seenBssids := value ]

ssid

SSID of the Wi-Fi network. Must be specified.

clearSettingWirelessSsid :: (MonadIO m, IsSettingWireless o) => o -> m ()

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

clear #ssid

constructSettingWirelessSsid :: (IsSettingWireless o, MonadIO m) => Bytes -> m (GValueConstruct o)

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

getSettingWirelessSsid :: (MonadIO m, IsSettingWireless o) => o -> m Bytes

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

get settingWireless #ssid

setSettingWirelessSsid :: (MonadIO m, IsSettingWireless o) => o -> Bytes -> m ()

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

set settingWireless [ #ssid := value ]

txPower

This property is not implemented and has no effect.

constructSettingWirelessTxPower :: (IsSettingWireless o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingWirelessTxPower :: (MonadIO m, IsSettingWireless o) => o -> m Word32

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

get settingWireless #txPower

setSettingWirelessTxPower :: (MonadIO m, IsSettingWireless o) => o -> Word32 -> m ()

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

set settingWireless [ #txPower := value ]

wakeOnWlan

The SettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of SettingWirelessWakeOnWLanAny, SettingWirelessWakeOnWLanDisconnect, SettingWirelessWakeOnWLanMagic, SettingWirelessWakeOnWLanGtkRekeyFailure, SettingWirelessWakeOnWLanEapIdentityRequest, SettingWirelessWakeOnWLan4wayHandshake, SettingWirelessWakeOnWLanRfkillRelease, SettingWirelessWakeOnWLanTcp or the special values SettingWirelessWakeOnWLanDefault (to use global settings) and SettingWirelessWakeOnWLanIgnore (to disable management of Wake-on-LAN in NetworkManager).

Since: 1.12

constructSettingWirelessWakeOnWlan :: (IsSettingWireless o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingWirelessWakeOnWlan :: (MonadIO m, IsSettingWireless o) => o -> m Word32

Get the value of the “wake-on-wlan” property. When overloading is enabled, this is equivalent to

get settingWireless #wakeOnWlan

setSettingWirelessWakeOnWlan :: (MonadIO m, IsSettingWireless o) => o -> Word32 -> m ()

Set the value of the “wake-on-wlan” property. When overloading is enabled, this is equivalent to

set settingWireless [ #wakeOnWlan := value ]