NMSettingWireless: libnm Reference Manual

## NMSettingWireless NMSettingWireless |

## Functions

NMSetting * | nm_setting_wireless_new ()
GBytes * | nm_setting_wireless_get_ssid ()
const char * | nm_setting_wireless_get_mode ()
const char * | nm_setting_wireless_get_band ()
guint32 | nm_setting_wireless_get_channel ()
const char * | nm_setting_wireless_get_bssid ()
guint32 | nm_setting_wireless_get_rate ()
guint32 | nm_setting_wireless_get_tx_power ()
const char * | nm_setting_wireless_get_mac_address ()
const char * | nm_setting_wireless_get_cloned_mac_address ()
const char * | nm_setting_wireless_get_generate_mac_address_mask ()
const char *const * | nm_setting_wireless_get_mac_address_blacklist ()
guint32 | nm_setting_wireless_get_num_mac_blacklist_items ()
const char * | nm_setting_wireless_get_mac_blacklist_item ()
gboolean | nm_setting_wireless_add_mac_blacklist_item ()
void | nm_setting_wireless_remove_mac_blacklist_item ()
gboolean | nm_setting_wireless_remove_mac_blacklist_item_by_value ()
void | nm_setting_wireless_clear_mac_blacklist_items ()
guint32 | nm_setting_wireless_get_mtu ()
gboolean | nm_setting_wireless_get_hidden ()
guint32 | nm_setting_wireless_get_powersave ()
NMSettingMacRandomization | nm_setting_wireless_get_mac_address_randomization ()
gboolean | nm_setting_wireless_add_seen_bssid ()
guint32 | nm_setting_wireless_get_num_seen_bssids ()
const char * | nm_setting_wireless_get_seen_bssid ()
gboolean | nm_setting_wireless_ap_security_compatible ()
NMSettingWirelessWakeOnWLan | nm_setting_wireless_get_wake_on_wlan ()
NMTernary | nm_setting_wireless_get_ap_isolation ()

## Types and Values

#define | NM_SETTING_WIRELESS_SETTING_NAME
enum | NMSettingWirelessWakeOnWLan
#define | NM_SETTING_WIRELESS_SSID
#define | NM_SETTING_WIRELESS_MODE
#define | NM_SETTING_WIRELESS_BAND
#define | NM_SETTING_WIRELESS_CHANNEL
#define | NM_SETTING_WIRELESS_BSSID
#define | NM_SETTING_WIRELESS_RATE
#define | NM_SETTING_WIRELESS_TX_POWER
#define | NM_SETTING_WIRELESS_MAC_ADDRESS
#define | NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS
#define | NM_SETTING_WIRELESS_GENERATE_MAC_ADDRESS_MASK
#define | NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST
#define | NM_SETTING_WIRELESS_MTU
#define | NM_SETTING_WIRELESS_SEEN_BSSIDS
#define | NM_SETTING_WIRELESS_HIDDEN
#define | NM_SETTING_WIRELESS_POWERSAVE
#define | NM_SETTING_WIRELESS_MAC_ADDRESS_RANDOMIZATION
#define | NM_SETTING_WIRELESS_WAKE_ON_WLAN
#define | NM_SETTING_WIRELESS_AP_ISOLATION
#define | NM_SETTING_WIRELESS_MODE_ADHOC
#define | NM_SETTING_WIRELESS_MODE_AP
#define | NM_SETTING_WIRELESS_MODE_INFRA
#define | NM_SETTING_WIRELESS_MODE_MESH
enum | NMSettingWirelessPowersave

## Object Hierarchy

        GEnum
        ╰── NMSettingWirelessPowersave
        GFlags
        ╰── NMSettingWirelessWakeOnWLan

## Description

## Functions

### nm_setting_wireless_new ()

    NMSetting *
    nm_setting_wireless_new (void);

### nm_setting_wireless_get_ssid ()

    GBytes *
    nm_setting_wireless_get_ssid (NMSettingWireless *setting);

### nm_setting_wireless_get_mode ()

    const char *
    nm_setting_wireless_get_mode (NMSettingWireless *setting);

### nm_setting_wireless_get_band ()

    const char *
    nm_setting_wireless_get_band (NMSettingWireless *setting);

### nm_setting_wireless_get_channel ()

    guint32
    nm_setting_wireless_get_channel (NMSettingWireless *setting);

### nm_setting_wireless_get_bssid ()

    const char *
    nm_setting_wireless_get_bssid (NMSettingWireless *setting);

### nm_setting_wireless_get_rate ()

    guint32
    nm_setting_wireless_get_rate (NMSettingWireless *setting);

### nm_setting_wireless_get_tx_power ()

    guint32
    nm_setting_wireless_get_tx_power (NMSettingWireless *setting);

### nm_setting_wireless_get_mac_address ()

    const char *
    nm_setting_wireless_get_mac_address (NMSettingWireless *setting);

### nm_setting_wireless_get_cloned_mac_address ()

    const char *
    nm_setting_wireless_get_cloned_mac_address
                                   (NMSettingWireless *setting);

### nm_setting_wireless_get_generate_mac_address_mask ()

    const char *
    nm_setting_wireless_get_generate_mac_address_mask
                                   (NMSettingWireless *setting);

### nm_setting_wireless_get_mac_address_blacklist ()

    const char *const *
    nm_setting_wireless_get_mac_address_blacklist
                                   (NMSettingWireless *setting);

### nm_setting_wireless_get_num_mac_blacklist_items ()

    guint32
    nm_setting_wireless_get_num_mac_blacklist_items
                                   (NMSettingWireless *setting);

### nm_setting_wireless_get_mac_blacklist_item ()

    const char *
    nm_setting_wireless_get_mac_blacklist_item
                                   (NMSettingWireless *setting,
                                    guint32 idx);

### nm_setting_wireless_add_mac_blacklist_item ()

    gboolean
    nm_setting_wireless_add_mac_blacklist_item
                                   (NMSettingWireless *setting,
                                    const char *mac);

### nm_setting_wireless_remove_mac_blacklist_item ()

    void
    nm_setting_wireless_remove_mac_blacklist_item
                                   (NMSettingWireless *setting,
                                    guint32 idx);

### nm_setting_wireless_remove_mac_blacklist_item_by_value ()

    gboolean
    nm_setting_wireless_remove_mac_blacklist_item_by_value
                                   (NMSettingWireless *setting,
                                    const char *mac);

### nm_setting_wireless_clear_mac_blacklist_items ()

    void
    nm_setting_wireless_clear_mac_blacklist_items
                                   (NMSettingWireless *setting);

### nm_setting_wireless_get_mtu ()

    guint32
    nm_setting_wireless_get_mtu (NMSettingWireless *setting);

### nm_setting_wireless_get_hidden ()

    gboolean
    nm_setting_wireless_get_hidden (NMSettingWireless *setting);

### nm_setting_wireless_get_powersave ()

    guint32
    nm_setting_wireless_get_powersave (NMSettingWireless *setting);

### nm_setting_wireless_get_mac_address_randomization ()

    NMSettingMacRandomization
    nm_setting_wireless_get_mac_address_randomization
                                   (NMSettingWireless *setting);

### nm_setting_wireless_add_seen_bssid ()

    gboolean
    nm_setting_wireless_add_seen_bssid (NMSettingWireless *setting,
                                        const char *bssid);

### nm_setting_wireless_get_num_seen_bssids ()

    guint32
    nm_setting_wireless_get_num_seen_bssids
                                   (NMSettingWireless *setting);

### nm_setting_wireless_get_seen_bssid ()

    const char *
    nm_setting_wireless_get_seen_bssid (NMSettingWireless *setting,
                                        guint32 i);

### nm_setting_wireless_ap_security_compatible ()

    gboolean
    nm_setting_wireless_ap_security_compatible
                                   (NMSettingWireless *s_wireless,
                                    NMSettingWirelessSecurity *s_wireless_sec,
                                    NM80211ApFlags ap_flags,
                                    NM80211ApSecurityFlags ap_wpa,
                                    NM80211ApSecurityFlags ap_rsn,
                                    NM80211Mode ap_mode);

### nm_setting_wireless_get_wake_on_wlan ()

    NMSettingWirelessWakeOnWLan
    nm_setting_wireless_get_wake_on_wlan (NMSettingWireless *setting);

### nm_setting_wireless_get_ap_isolation ()

    NMTernary
    nm_setting_wireless_get_ap_isolation (NMSettingWireless *setting);

## Types and Values

### NM_SETTING_WIRELESS_SETTING_NAME

    #define NM_SETTING_WIRELESS_SETTING_NAME "802-11-wireless"

### enum NMSettingWirelessWakeOnWLan

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

#### Members

NM_SETTING_WIRELESS_WAKE_ON_WLAN_NONE | Wake-on-WLAN disabled |
NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY | Wake on any activity |
NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT | Wake on disconnect |
NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC | Wake on magic packet |
NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE | Wake on GTK rekey failure |
NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST | Wake on EAP identity request |
NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE | Wake on 4way handshake |
NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE | Wake on rfkill release |
NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP |  |
NM_SETTING_WIRELESS_WAKE_ON_WLAN_ALL | Wake on all events. This does not include the exclusive flags `NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT` or `NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE` . |
NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT | Use the default value |
NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE | Don't change configured settings |
NM_SETTING_WIRELESS_WAKE_ON_WLAN_EXCLUSIVE_FLAGS | Mask of flags that are incompatible with other flags |

Since: 1.12

### NM_SETTING_WIRELESS_SSID

    #define NM_SETTING_WIRELESS_SSID                      "ssid"

### NM_SETTING_WIRELESS_MODE

    #define NM_SETTING_WIRELESS_MODE                      "mode"

### NM_SETTING_WIRELESS_BAND

    #define NM_SETTING_WIRELESS_BAND                      "band"

### NM_SETTING_WIRELESS_CHANNEL

    #define NM_SETTING_WIRELESS_CHANNEL                   "channel"

### NM_SETTING_WIRELESS_BSSID

    #define NM_SETTING_WIRELESS_BSSID                     "bssid"

### NM_SETTING_WIRELESS_RATE

    #define NM_SETTING_WIRELESS_RATE                      "rate"

### NM_SETTING_WIRELESS_TX_POWER

    #define NM_SETTING_WIRELESS_TX_POWER                  "tx-power"

### NM_SETTING_WIRELESS_MAC_ADDRESS

    #define NM_SETTING_WIRELESS_MAC_ADDRESS               "mac-address"

### NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS

    #define NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS        "cloned-mac-address"

### NM_SETTING_WIRELESS_GENERATE_MAC_ADDRESS_MASK

    #define NM_SETTING_WIRELESS_GENERATE_MAC_ADDRESS_MASK "generate-mac-address-mask"

### NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST

    #define NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST     "mac-address-blacklist"

### NM_SETTING_WIRELESS_MTU

    #define NM_SETTING_WIRELESS_MTU                       "mtu"

### NM_SETTING_WIRELESS_SEEN_BSSIDS

    #define NM_SETTING_WIRELESS_SEEN_BSSIDS               "seen-bssids"

### NM_SETTING_WIRELESS_HIDDEN

    #define NM_SETTING_WIRELESS_HIDDEN                    "hidden"

### NM_SETTING_WIRELESS_POWERSAVE

    #define NM_SETTING_WIRELESS_POWERSAVE                 "powersave"

### NM_SETTING_WIRELESS_MAC_ADDRESS_RANDOMIZATION

    #define NM_SETTING_WIRELESS_MAC_ADDRESS_RANDOMIZATION "mac-address-randomization"

### NM_SETTING_WIRELESS_WAKE_ON_WLAN

    #define NM_SETTING_WIRELESS_WAKE_ON_WLAN              "wake-on-wlan"

### NM_SETTING_WIRELESS_AP_ISOLATION

    #define NM_SETTING_WIRELESS_AP_ISOLATION              "ap-isolation"

### NM_SETTING_WIRELESS_MODE_ADHOC

    #define NM_SETTING_WIRELESS_MODE_ADHOC "adhoc"

Indicates Ad-Hoc mode where no access point is expected to be present.

### NM_SETTING_WIRELESS_MODE_AP

    #define NM_SETTING_WIRELESS_MODE_AP "ap"

Indicates AP/master mode where the wireless device is started as an access point/hotspot.

### NM_SETTING_WIRELESS_MODE_INFRA

    #define NM_SETTING_WIRELESS_MODE_INFRA "infrastructure"

Indicates infrastructure mode where an access point is expected to be present for this connection.

### NM_SETTING_WIRELESS_MODE_MESH

    #define NM_SETTING_WIRELESS_MODE_MESH "mesh"

Indicates that the connection should create a mesh point.

Since: 1.20

### enum NMSettingWirelessPowersave

These flags indicate whether wireless powersave must be enabled.

#### Members

NM_SETTING_WIRELESS_POWERSAVE_DEFAULT | use the default value |
NM_SETTING_WIRELESS_POWERSAVE_IGNORE | don't touch existing setting |
NM_SETTING_WIRELESS_POWERSAVE_DISABLE | disable powersave |
NM_SETTING_WIRELESS_POWERSAVE_ENABLE | enable powersave |
_NM_SETTING_WIRELESS_POWERSAVE_NUM |  |
NM_SETTING_WIRELESS_POWERSAVE_LAST |  |

Since: 1.2