From e74c568b07b50b97873fb4ee1d776dedefbd54d6 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 1 Oct 2021 23:05:04 +0200 Subject: New upstream version 1.32.12 --- docs/libnm/html/NMSettingWireless.html | 434 ++------------------------------- 1 file changed, 19 insertions(+), 415 deletions(-) (limited to 'docs/libnm/html/NMSettingWireless.html') diff --git a/docs/libnm/html/NMSettingWireless.html b/docs/libnm/html/NMSettingWireless.html index 0ce428a4..18a91960 100644 --- a/docs/libnm/html/NMSettingWireless.html +++ b/docs/libnm/html/NMSettingWireless.html @@ -16,8 +16,7 @@ Top  |  Description  |  - Object Hierarchy  |  - Properties + Object Hierarchy Home Up @@ -260,115 +259,6 @@
-

Properties

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NMTernaryap-isolationRead / Write
-char *bandRead / Write
-char *bssidRead / Write
guintchannelRead / Write
-char *cloned-mac-addressRead / Write
-char *generate-mac-address-maskRead / Write
gbooleanhiddenRead / Write
-char *mac-addressRead / Write
GStrvmac-address-blacklistRead / Write
guintmac-address-randomizationRead / Write
-char *modeRead / Write
guintmtuRead / Write
guintpowersaveRead / Write
guintrateRead / Write
GStrvseen-bssidsRead / Write
-GBytes *ssidRead / Write
guinttx-powerRead / Write
guintwake-on-wlanRead / Write
-
-

Types and Values

@@ -476,10 +366,6 @@ - - - -
enum NMSettingWirelessPowersave
 NMSettingWireless
@@ -489,9 +375,6 @@ ╰── NMSettingWirelessPowersave GFlags ╰── NMSettingWirelessWakeOnWLan - GObject - ╰── NMSetting - ╰── NMSettingWireless
@@ -534,7 +417,7 @@ nm_setting_wireless_get_ssid (

Returns

-

the “ssid” property of the setting.

+

the “ssid” property of the setting.

[transfer none]

@@ -560,7 +443,7 @@ nm_setting_wireless_get_mode (

Returns

-

the “mode” property of the setting

+

the “mode” property of the setting

@@ -585,7 +468,7 @@ nm_setting_wireless_get_band (

Returns

-

the “band” property of the setting

+

the “band” property of the setting

@@ -610,7 +493,7 @@ nm_setting_wireless_get_channel (

Returns

-

the “channel” property of the setting

+

the “channel” property of the setting

@@ -635,7 +518,7 @@ nm_setting_wireless_get_bssid (

Returns

-

the “bssid” property of the setting

+

the “bssid” property of the setting

@@ -660,7 +543,7 @@ nm_setting_wireless_get_rate (

Returns

-

the “rate” property of the setting

+

the “rate” property of the setting

@@ -685,7 +568,7 @@ nm_setting_wireless_get_tx_power (

Returns

-

the “tx-power” property of the setting

+

the “tx-power” property of the setting

@@ -710,7 +593,7 @@ nm_setting_wireless_get_mac_address (

Returns

-

the “mac-address” property of the setting

+

the “mac-address” property of the setting

@@ -736,7 +619,7 @@ nm_setting_wireless_get_cloned_mac_address

Returns

-

the “cloned-mac-address” property of the setting

+

the “cloned-mac-address” property of the setting

@@ -762,7 +645,7 @@ nm_setting_wireless_get_generate_mac_address_mask

Returns

-

the “generate-mac-address-mask” property of the setting

+

the “generate-mac-address-mask” property of the setting

Since: 1.4

@@ -789,7 +672,7 @@ nm_setting_wireless_get_mac_address_blacklist

Returns

-

the “mac-address-blacklist” property of the setting

+

the “mac-address-blacklist” property of the setting

@@ -861,7 +744,7 @@ at index idx nm_setting_wireless_add_mac_blacklist_item (NMSettingWireless *setting, const char *mac); -

Adds a new MAC address to the “mac-address-blacklist” property.

+

Adds a new MAC address to the “mac-address-blacklist” property.

Parameters

@@ -1004,7 +887,7 @@ nm_setting_wireless_get_mtu (

Returns

-

the “mtu” property of the setting

+

the “mtu” property of the setting

@@ -1029,7 +912,7 @@ nm_setting_wireless_get_hidden (

Returns

-

the “hidden” property of the setting

+

the “hidden” property of the setting

@@ -1054,7 +937,7 @@ nm_setting_wireless_get_powersave (

Returns

-

the “powersave” property of the setting

+

the “powersave” property of the setting

Since: 1.2

@@ -1081,7 +964,7 @@ nm_setting_wireless_get_mac_address_randomization

Returns

-

the “mac-address-randomization” property of the +

the “mac-address-randomization” property of the setting

Since: 1.2

@@ -1300,7 +1183,7 @@ nm_setting_wireless_get_ap_isolation (

Returns

-

the “ap-isolation” property of the setting

+

the “ap-isolation” property of the setting

Since: 1.28

@@ -1315,7 +1198,7 @@ nm_setting_wireless_get_ap_isolation (

enum NMSettingWirelessWakeOnWLan

-

Options for “wake-on-wlan”. Note that not all options +

Options for “wake-on-wlan”. Note that not all options are supported by all devices.

Members

@@ -1619,285 +1502,6 @@ for this connection.

-
-
-

NMSettingWireless

-
typedef struct _NMSettingWireless NMSettingWireless;
-

Wi-Fi Settings

-
- -
-

Property Details

-
-

The “ap-isolation” property

-
  “ap-isolation”             NMTernary
-

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

-

If set to NM_TERNARY_TRUE, 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 NM_TERNARY_FALSE, devices can talk to each other.

-

When set to NM_TERNARY_DEFAULT, the global default is used; in -case the global default is unspecified it is assumed to be -NM_TERNARY_FALSE.

-

Owner: NMSettingWireless

-

Flags: Read / Write

-

Default value: NM_TERNARY_DEFAULT

-

Since: 1.28

-
-
-
-

The “band” property

-
  “band”                     char *
-

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.

-

Owner: NMSettingWireless

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “bssid” property

-
  “bssid”                    char *
-

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.

-

Owner: NMSettingWireless

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “channel” property

-
  “channel”                  guint
-

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.

-

Owner: NMSettingWireless

-

Flags: Read / Write

-

Default value: 0

-
-
-
-

The “cloned-mac-address” property

-
  “cloned-mac-address”       char *
-

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" and "stable" 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.

-

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

-

Owner: NMSettingWireless

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “generate-mac-address-mask” property

-
  “generate-mac-address-mask” char *
-

With “cloned-mac-address” 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 NULL, it is eligible to be overwritten by a default -connection setting. If the value is still NULL 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.

-

Owner: NMSettingWireless

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “hidden” property

-
  “hidden”                   gboolean
-

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.

-

Owner: NMSettingWireless

-

Flags: Read / Write

-

Default value: FALSE

-
-
-
-

The “mac-address” property

-
  “mac-address”              char *
-

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

-

Owner: NMSettingWireless

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “mac-address-blacklist” property

-
  “mac-address-blacklist”    GStrv
-

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").

-

Owner: NMSettingWireless

-

Flags: Read / Write

-
-
-
-

The “mac-address-randomization” property

-
  “mac-address-randomization” guint
-

One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (never randomize unless -the user has set a global default to randomize and the supplicant -supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (never -randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS -(always randomize the MAC address). This property is deprecated for -'cloned-mac-address'.

-
-

NMSettingWireless:mac-address-randomization has been deprecated since version 1.4 and should not be used in newly-written code.

-

Deprecated by NMSettingWireless:cloned-mac-address property.

-
-

Owner: NMSettingWireless

-

Flags: Read / Write

-

Default value: 0

-

Since: 1.2

-
-
-
-

The “mode” property

-
  “mode”                     char *
-

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

-

Owner: NMSettingWireless

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “mtu” property

-
  “mtu”                      guint
-

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

-

Owner: NMSettingWireless

-

Flags: Read / Write

-

Default value: 0

-
-
-
-

The “powersave” property

-
  “powersave”                guint
-

One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (disable Wi-Fi power -saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (enable Wi-Fi power -saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (don't touch currently -configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (use the -globally configured value). All other values are reserved.

-

Owner: NMSettingWireless

-

Flags: Read / Write

-

Default value: 0

-

Since: 1.2

-
-
-
-

The “rate” property

-
  “rate”                     guint
-

If non-zero, directs the device to only use the specified bitrate for -communication with the access point. Units are in Kb/s, ie 5500 = 5.5 -Mbit/s. This property is highly driver dependent and not all devices -support setting a static bitrate.

-

Owner: NMSettingWireless

-

Flags: Read / Write

-

Default value: 0

-
-
-
-

The “seen-bssids” property

-
  “seen-bssids”              GStrv
-

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.

-

Owner: NMSettingWireless

-

Flags: Read / Write

-
-
-
-

The “ssid” property

-
  “ssid”                     GBytes *
-

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

-

Owner: NMSettingWireless

-

Flags: Read / Write

-
-
-
-

The “tx-power” property

-
  “tx-power”                 guint
-

If non-zero, directs the device to use the specified transmit power. -Units are dBm. This property is highly driver dependent and not all -devices support setting a static transmit power.

-

Owner: NMSettingWireless

-

Flags: Read / Write

-

Default value: 0

-
-
-
-

The “wake-on-wlan” property

-
  “wake-on-wlan”             guint
-

The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. -May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY, -NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT, -NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC, -NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE, -NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST, -NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE, -NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE, -NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP or the special values -NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (to use global settings) and -NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (to disable management of Wake-on-LAN in -NetworkManager).

-

Owner: NMSettingWireless

-

Flags: Read / Write

-

Default value: 1

-

Since: 1.12

-
-- cgit 1.3.0-6-gf8a5