Gjsify LogoGjsify Logo

Interface SettingWireless_ConstructProps

Hierarchy

Index

Properties

ap_isolation?: Ternary

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.

band?: string

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.

bssid?: string

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.

channel?: number

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.

cloned_mac_address?: string

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

generate_mac_address_mask?: string

With #NMSettingWireless: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.

hidden?: boolean

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.

mac_address?: string

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

mac_address_blacklist?: string[]

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

mac_address_randomization?: number

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

mode?: string

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

mtu?: number

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

powersave?: number

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.

rate?: number

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.

seen_bssids?: string[]

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.

ssid?: Bytes

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

tx_power?: number

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.

wake_on_wlan?: number

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

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method