![]() |
![]() |
![]() |
libnm-util Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#include <nm-setting-wireless.h> #define NM_SETTING_WIRELESS_SETTING_NAME enum NMSettingWirelessError; #define NM_SETTING_WIRELESS_ERROR GQuark nm_setting_wireless_error_quark (void
); #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_MAC_ADDRESS_BLACKLIST #define NM_SETTING_WIRELESS_MTU #define NM_SETTING_WIRELESS_SEEN_BSSIDS #define NM_SETTING_WIRELESS_HIDDEN #define NM_SETTING_WIRELESS_SEC #define NM_SETTING_WIRELESS_MODE_ADHOC #define NM_SETTING_WIRELESS_MODE_AP #define NM_SETTING_WIRELESS_MODE_INFRA NMSettingWireless; NMSettingWirelessClass; NMSetting * nm_setting_wireless_new (void
); const GByteArray * nm_setting_wireless_get_ssid (NMSettingWireless *setting
); const char * nm_setting_wireless_get_mode (NMSettingWireless *setting
); const char * nm_setting_wireless_get_band (NMSettingWireless *setting
); guint32 nm_setting_wireless_get_channel (NMSettingWireless *setting
); const GByteArray * nm_setting_wireless_get_bssid (NMSettingWireless *setting
); guint32 nm_setting_wireless_get_rate (NMSettingWireless *setting
); guint32 nm_setting_wireless_get_tx_power (NMSettingWireless *setting
); const GByteArray * nm_setting_wireless_get_mac_address (NMSettingWireless *setting
); const GByteArray * nm_setting_wireless_get_cloned_mac_address (NMSettingWireless *setting
); const GSList * nm_setting_wireless_get_mac_address_blacklist (NMSettingWireless *setting
); guint32 nm_setting_wireless_get_num_mac_blacklist_items (NMSettingWireless *setting
); const char * nm_setting_wireless_get_mac_blacklist_item (NMSettingWireless *setting
,guint32 idx
); gboolean nm_setting_wireless_add_mac_blacklist_item (NMSettingWireless *setting
,const char *mac
); void nm_setting_wireless_remove_mac_blacklist_item (NMSettingWireless *setting
,guint32 idx
); gboolean nm_setting_wireless_remove_mac_blacklist_item_by_value (NMSettingWireless *setting
,const char *mac
); void nm_setting_wireless_clear_mac_blacklist_items (NMSettingWireless *setting
); guint32 nm_setting_wireless_get_mtu (NMSettingWireless *setting
); gboolean nm_setting_wireless_get_hidden (NMSettingWireless *setting
); gboolean nm_setting_wireless_add_seen_bssid (NMSettingWireless *setting
,const char *bssid
); guint32 nm_setting_wireless_get_num_seen_bssids (NMSettingWireless *setting
); const char * nm_setting_wireless_get_seen_bssid (NMSettingWireless *setting
,guint32 i
); 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
); const char * nm_setting_wireless_get_security (NMSettingWireless *setting
);
"band" gchar* : Read / Write "bssid" GArray_guchar_* : Read / Write "channel" guint : Read / Write / Construct "cloned-mac-address" GArray_guchar_* : Read / Write "hidden" gboolean : Read / Write "mac-address" GArray_guchar_* : Read / Write "mac-address-blacklist" GSList_gchararray_* : Read / Write "mode" gchar* : Read / Write "mtu" guint : Read / Write / Construct "rate" guint : Read / Write / Construct "security" gchar* : Read / Write "seen-bssids" GSList_gchararray_* : Read / Write "ssid" GArray_guchar_* : Read / Write "tx-power" guint : Read / Write / Construct
The NMSettingWireless object is a NMSetting subclass that describes properties necessary for connection to 802.11 Wi-Fi networks.
typedef enum { NM_SETTING_WIRELESS_ERROR_UNKNOWN = 0, /*< nick=UnknownError >*/ NM_SETTING_WIRELESS_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/ NM_SETTING_WIRELESS_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/ NM_SETTING_WIRELESS_ERROR_MISSING_SECURITY_SETTING, /*< nick=MissingSecuritySetting >*/ NM_SETTING_WIRELESS_ERROR_CHANNEL_REQUIRES_BAND /*< nick=ChannelRequiresBand >*/ } NMSettingWirelessError;
unknown or unclassified error | |
the property was invalid | |
the property was missing and is required | |
property values require the presence of an NMSettingWirelessSecurity object in the connection | |
the property channel was set to a value that requires the "band" property to be set |
GQuark nm_setting_wireless_error_quark (void
);
Registers an error quark for NMSettingWireless if necessary.
Returns : |
the error quark used for NMSettingWireless errors. |
#define NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS "cloned-mac-address"
#define NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
#define NM_SETTING_WIRELESS_MODE_ADHOC "adhoc"
Indicates Ad-Hoc mode where no access point is expected to be present.
#define NM_SETTING_WIRELESS_MODE_AP "ap"
Indicates AP/master mode where the wireless device is started as an access point/hotspot.
Since 0.9.8
#define NM_SETTING_WIRELESS_MODE_INFRA "infrastructure"
Indicates infrastructure mode where an access point is expected to be present for this connection.
typedef struct { NMSettingClass parent; /* Padding for future expansion */ void (*_reserved1) (void); void (*_reserved2) (void); void (*_reserved3) (void); void (*_reserved4) (void); } NMSettingWirelessClass;
NMSetting * nm_setting_wireless_new (void
);
Creates a new NMSettingWireless object with default values.
Returns : |
the new empty NMSettingWireless object. [transfer full] |
const GByteArray * nm_setting_wireless_get_ssid (NMSettingWireless *setting
);
|
the NMSettingWireless |
Returns : |
the "ssid" property of the setting |
const char * nm_setting_wireless_get_mode (NMSettingWireless *setting
);
|
the NMSettingWireless |
Returns : |
the "mode" property of the setting |
const char * nm_setting_wireless_get_band (NMSettingWireless *setting
);
|
the NMSettingWireless |
Returns : |
the "band" property of the setting |
guint32 nm_setting_wireless_get_channel (NMSettingWireless *setting
);
|
the NMSettingWireless |
Returns : |
the "channel" property of the setting |
const GByteArray * nm_setting_wireless_get_bssid (NMSettingWireless *setting
);
|
the NMSettingWireless |
Returns : |
the "bssid" property of the setting |
guint32 nm_setting_wireless_get_rate (NMSettingWireless *setting
);
|
the NMSettingWireless |
Returns : |
the "rate" property of the setting |
guint32 nm_setting_wireless_get_tx_power (NMSettingWireless *setting
);
|
the NMSettingWireless |
Returns : |
the "tx-power" property of the setting |
const GByteArray * nm_setting_wireless_get_mac_address (NMSettingWireless *setting
);
|
the NMSettingWireless |
Returns : |
the "mac-address" property of the setting |
const GByteArray * nm_setting_wireless_get_cloned_mac_address
(NMSettingWireless *setting
);
|
the NMSettingWireless |
Returns : |
the "cloned-mac-address" property of the setting |
const GSList * nm_setting_wireless_get_mac_address_blacklist
(NMSettingWireless *setting
);
|
the NMSettingWireless |
Returns : |
the "mac-address-blacklist" property of the setting. [element-type GLib.ByteArray] |
guint32 nm_setting_wireless_get_num_mac_blacklist_items
(NMSettingWireless *setting
);
|
the NMSettingWireless |
Returns : |
the number of blacklisted MAC addresses |
Since 0.9.10
const char * nm_setting_wireless_get_mac_blacklist_item (NMSettingWireless *setting
,guint32 idx
);
|
the NMSettingWireless |
|
the zero-based index of the MAC address entry |
Returns : |
the blacklisted MAC address string (hex-digits-and-colons notation)
at index idx
|
Since 0.9.10
gboolean nm_setting_wireless_add_mac_blacklist_item (NMSettingWireless *setting
,const char *mac
);
Adds a new MAC address to the "mac-address-blacklist" property.
|
the NMSettingWireless |
|
the MAC address string (hex-digits-and-colons notation) to blacklist |
Returns : |
TRUE if the MAC address was added; FALSE if the MAC address
is invalid or was already present |
Since 0.9.10
void nm_setting_wireless_remove_mac_blacklist_item (NMSettingWireless *setting
,guint32 idx
);
Removes the MAC address at index idx
from the blacklist.
|
the NMSettingWireless |
|
index number of the MAC address |
Since 0.9.10
gboolean nm_setting_wireless_remove_mac_blacklist_item_by_value (NMSettingWireless *setting
,const char *mac
);
Removes the MAC address mac
from the blacklist.
|
the NMSettingWireless |
|
the MAC address string (hex-digits-and-colons notation) to remove from the blacklist |
Returns : |
TRUE if the MAC address was found and removed; FALSE if it was not. |
Since 0.9.10
void nm_setting_wireless_clear_mac_blacklist_items
(NMSettingWireless *setting
);
Removes all blacklisted MAC addresses.
|
the NMSettingWireless |
Since 0.9.10
guint32 nm_setting_wireless_get_mtu (NMSettingWireless *setting
);
|
the NMSettingWireless |
Returns : |
the "mtu" property of the setting |
gboolean nm_setting_wireless_get_hidden (NMSettingWireless *setting
);
|
the NMSettingWireless |
Returns : |
the "hidden" property of the setting |
gboolean nm_setting_wireless_add_seen_bssid (NMSettingWireless *setting
,const char *bssid
);
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.
|
the NMSettingWireless |
|
the new BSSID to add to the list |
Returns : |
TRUE if bssid was already known, FALSE if not |
guint32 nm_setting_wireless_get_num_seen_bssids
(NMSettingWireless *setting
);
|
the NMSettingWireless |
Returns : |
the number of BSSIDs in the previously seen BSSID list |
const char * nm_setting_wireless_get_seen_bssid (NMSettingWireless *setting
,guint32 i
);
|
the NMSettingWireless |
|
index of a BSSID in the previously seen BSSID list |
Returns : |
the BSSID at index i
|
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
);
Given a NMSettingWireless and an optional NMSettingWirelessSecurity, 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.
|
a NMSettingWireless |
|
a NMSettingWirelessSecurity or NULL
|
|
the NM80211ApFlags of the given access point |
|
the NM80211ApSecurityFlags of the given access point's WPA
capabilities |
|
the NM80211ApSecurityFlags of the given access point's WPA2/RSN
capabilities |
|
the 802.11 mode of the AP, either Ad-Hoc or Infrastructure |
Returns : |
TRUE if the given settings are compatible with the access point's
security flags and mode, FALSE if they are not. |
const char * nm_setting_wireless_get_security (NMSettingWireless *setting
);
nm_setting_wireless_get_security
has been deprecated since version 0.9.10 and should not be used in newly-written code. No longer used. Security rescrictions are recognized by
the presence of NM_SETTING_WIRELESS_SECURITY_SETTING_NAME in the connection.
|
the NMSettingWireless |
Returns : |
the "security" property of the setting |
"band"
property"band" gchar* : Read / Write
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.
Default value: NULL
"bssid"
property "bssid" GArray_guchar_* : Read / Write
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"
property"channel" guint : Read / Write / Construct
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.
Default value: 0
"cloned-mac-address"
property "cloned-mac-address" GArray_guchar_* : Read / Write
If specified, request that the Wi-Fi device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.
"hidden"
property"hidden" gboolean : Read / Write
If TRUE
, indicates this network is a non-broadcasting network that hides
its SSID. In this case various workarounds may take place, such as
probe-scanning the SSID for more reliable network discovery. However,
these workarounds expose inherent insecurities with hidden SSID networks,
and thus hidden SSID networks should be used with caution.
Default value: FALSE
"mac-address"
property "mac-address" GArray_guchar_* : Read / Write
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"
property "mac-address-blacklist" GSList_gchararray_* : Read / Write
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").
"mode"
property"mode" gchar* : Read / Write
Wi-Fi network mode; one of "infrastructure", "adhoc" or "ap". If blank, infrastructure is assumed.
Default value: NULL
"mtu"
property"mtu" guint : Read / Write / Construct
If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.
Default value: 0
"rate"
property"rate" guint : Read / Write / Construct
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.
Default value: 0
"security"
property"security" gchar* : Read / Write
NMSettingWireless:security
has been deprecated since version 0.9.10 and should not be used in newly-written code. No longer used. Security restrictions are recognized
by the presence of a NMSettingWirelessSecurity setting in the
connection.
If the wireless connection has any security restrictions, like 802.1x,
WEP, or WPA, set this property to
NM_SETTING_WIRELESS_SECURITY_SETTING_NAME
and ensure the connection
contains a valid NMSettingWirelessSecurity setting.
Default value: NULL
"seen-bssids"
property "seen-bssids" GSList_gchararray_* : Read / Write
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"
property "ssid" GArray_guchar_* : Read / Write
SSID of the Wi-Fi network. Must be specified.
"tx-power"
property"tx-power" guint : Read / Write / Construct
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.
Default value: 0