diff options
Diffstat (limited to 'docs/libnm/html/NMSettingWireless.html')
| -rw-r--r-- | docs/libnm/html/NMSettingWireless.html | 434 |
1 files changed, 19 insertions, 415 deletions
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 @@ <td width="100%" align="left" class="shortcuts"> <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> <a href="#NMSettingWireless.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#NMSettingWireless.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#NMSettingWireless.properties" class="shortcut">Properties</a></span> + <a href="#NMSettingWireless.object-hierarchy" class="shortcut">Object Hierarchy</a></span> </td> <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> <td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> @@ -260,115 +259,6 @@ </table></div> </div> <div class="refsect1"> -<a name="NMSettingWireless.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"><a class="link" href="libnm-nm-dbus-interface.html#NMTernary" title="enum NMTernary"><span class="type">NMTernary</span></a></td> -<td class="property_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless--ap-isolation" title="The “ap-isolation” property">ap-isolation</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">char</span> *</td> -<td class="property_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless--band" title="The “band” property">band</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">char</span> *</td> -<td class="property_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless--bssid" title="The “bssid” property">bssid</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> -<td class="property_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless--channel" title="The “channel” property">channel</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">char</span> *</td> -<td class="property_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless--cloned-mac-address" title="The “cloned-mac-address” property">cloned-mac-address</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">char</span> *</td> -<td class="property_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless--generate-mac-address-mask" title="The “generate-mac-address-mask” property">generate-mac-address-mask</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> -<td class="property_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless--hidden" title="The “hidden” property">hidden</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">char</span> *</td> -<td class="property_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless--mac-address" title="The “mac-address” property">mac-address</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></td> -<td class="property_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless--mac-address-blacklist" title="The “mac-address-blacklist” property">mac-address-blacklist</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> -<td class="property_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless--mac-address-randomization" title="The “mac-address-randomization” property">mac-address-randomization</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">char</span> *</td> -<td class="property_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless--mode" title="The “mode” property">mode</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> -<td class="property_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless--mtu" title="The “mtu” property">mtu</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> -<td class="property_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless--powersave" title="The “powersave” property">powersave</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> -<td class="property_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless--rate" title="The “rate” property">rate</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></td> -<td class="property_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless--seen-bssids" title="The “seen-bssids” property">seen-bssids</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<a href="https://developer.gnome.org/glib/unstable/glib-Byte-Arrays.html#GBytes"><span class="type">GBytes</span></a> *</td> -<td class="property_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless--ssid" title="The “ssid” property">ssid</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> -<td class="property_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless--tx-power" title="The “tx-power” property">tx-power</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> -<td class="property_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless--wake-on-wlan" title="The “wake-on-wlan” property">wake-on-wlan</a></td> -<td class="property_flags">Read / Write</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> <a name="NMSettingWireless.other"></a><h2>Types and Values</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> @@ -476,10 +366,6 @@ <td class="datatype_keyword">enum</td> <td class="function_name"><a class="link" href="NMSettingWireless.html#NMSettingWirelessPowersave" title="enum NMSettingWirelessPowersave">NMSettingWirelessPowersave</a></td> </tr> -<tr> -<td class="datatype_keyword"> </td> -<td class="function_name"><a class="link" href="NMSettingWireless.html#NMSettingWireless-struct" title="NMSettingWireless">NMSettingWireless</a></td> -</tr> </tbody> </table></div> </div> @@ -489,9 +375,6 @@ <span class="lineart">╰──</span> NMSettingWirelessPowersave <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a> <span class="lineart">╰──</span> NMSettingWirelessWakeOnWLan - <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> - <span class="lineart">╰──</span> <a class="link" href="NMSetting.html" title="NMSetting">NMSetting</a> - <span class="lineart">╰──</span> NMSettingWireless </pre> </div> <div class="refsect1"> @@ -534,7 +417,7 @@ nm_setting_wireless_get_ssid (<em class="parameter"><code><a class="link" href=" </div> <div class="refsect3"> <a name="nm-setting-wireless-get-ssid.returns"></a><h4>Returns</h4> -<p>the <a class="link" href="NMSettingWireless.html#NMSettingWireless--ssid" title="The “ssid” property"><span class="type">“ssid”</span></a> property of the setting. </p> +<p>the <a href="NMSettingWireless.html#NMSettingWireless--ssid"><span class="type">“ssid”</span></a> property of the setting. </p> <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> </div> </div> @@ -560,7 +443,7 @@ nm_setting_wireless_get_mode (<em class="parameter"><code><a class="link" href=" </div> <div class="refsect3"> <a name="nm-setting-wireless-get-mode.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--mode" title="The “mode” property"><span class="type">“mode”</span></a> property of the setting</p> +<p> the <a href="NMSettingWireless.html#NMSettingWireless--mode"><span class="type">“mode”</span></a> property of the setting</p> </div> </div> <hr> @@ -585,7 +468,7 @@ nm_setting_wireless_get_band (<em class="parameter"><code><a class="link" href=" </div> <div class="refsect3"> <a name="nm-setting-wireless-get-band.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--band" title="The “band” property"><span class="type">“band”</span></a> property of the setting</p> +<p> the <a href="NMSettingWireless.html#NMSettingWireless--band"><span class="type">“band”</span></a> property of the setting</p> </div> </div> <hr> @@ -610,7 +493,7 @@ nm_setting_wireless_get_channel (<em class="parameter"><code><a class="link" hre </div> <div class="refsect3"> <a name="nm-setting-wireless-get-channel.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--channel" title="The “channel” property"><span class="type">“channel”</span></a> property of the setting</p> +<p> the <a href="NMSettingWireless.html#NMSettingWireless--channel"><span class="type">“channel”</span></a> property of the setting</p> </div> </div> <hr> @@ -635,7 +518,7 @@ nm_setting_wireless_get_bssid (<em class="parameter"><code><a class="link" href= </div> <div class="refsect3"> <a name="nm-setting-wireless-get-bssid.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--bssid" title="The “bssid” property"><span class="type">“bssid”</span></a> property of the setting</p> +<p> the <a href="NMSettingWireless.html#NMSettingWireless--bssid"><span class="type">“bssid”</span></a> property of the setting</p> </div> </div> <hr> @@ -660,7 +543,7 @@ nm_setting_wireless_get_rate (<em class="parameter"><code><a class="link" href=" </div> <div class="refsect3"> <a name="nm-setting-wireless-get-rate.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--rate" title="The “rate” property"><span class="type">“rate”</span></a> property of the setting</p> +<p> the <a href="NMSettingWireless.html#NMSettingWireless--rate"><span class="type">“rate”</span></a> property of the setting</p> </div> </div> <hr> @@ -685,7 +568,7 @@ nm_setting_wireless_get_tx_power (<em class="parameter"><code><a class="link" hr </div> <div class="refsect3"> <a name="nm-setting-wireless-get-tx-power.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--tx-power" title="The “tx-power” property"><span class="type">“tx-power”</span></a> property of the setting</p> +<p> the <a href="NMSettingWireless.html#NMSettingWireless--tx-power"><span class="type">“tx-power”</span></a> property of the setting</p> </div> </div> <hr> @@ -710,7 +593,7 @@ nm_setting_wireless_get_mac_address (<em class="parameter"><code><a class="link" </div> <div class="refsect3"> <a name="nm-setting-wireless-get-mac-address.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--mac-address" title="The “mac-address” property"><span class="type">“mac-address”</span></a> property of the setting</p> +<p> the <a href="NMSettingWireless.html#NMSettingWireless--mac-address"><span class="type">“mac-address”</span></a> property of the setting</p> </div> </div> <hr> @@ -736,7 +619,7 @@ nm_setting_wireless_get_cloned_mac_address </div> <div class="refsect3"> <a name="nm-setting-wireless-get-cloned-mac-address.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--cloned-mac-address" title="The “cloned-mac-address” property"><span class="type">“cloned-mac-address”</span></a> property of the setting</p> +<p> the <a href="NMSettingWireless.html#NMSettingWireless--cloned-mac-address"><span class="type">“cloned-mac-address”</span></a> property of the setting</p> </div> </div> <hr> @@ -762,7 +645,7 @@ nm_setting_wireless_get_generate_mac_address_mask </div> <div class="refsect3"> <a name="nm-setting-wireless-get-generate-mac-address-mask.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--generate-mac-address-mask" title="The “generate-mac-address-mask” property"><span class="type">“generate-mac-address-mask”</span></a> property of the setting</p> +<p> the <a href="NMSettingWireless.html#NMSettingWireless--generate-mac-address-mask"><span class="type">“generate-mac-address-mask”</span></a> property of the setting</p> </div> <p class="since">Since: 1.4</p> </div> @@ -789,7 +672,7 @@ nm_setting_wireless_get_mac_address_blacklist </div> <div class="refsect3"> <a name="nm-setting-wireless-get-mac-address-blacklist.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--mac-address-blacklist" title="The “mac-address-blacklist” property"><span class="type">“mac-address-blacklist”</span></a> property of the setting</p> +<p> the <a href="NMSettingWireless.html#NMSettingWireless--mac-address-blacklist"><span class="type">“mac-address-blacklist”</span></a> property of the setting</p> </div> </div> <hr> @@ -861,7 +744,7 @@ at index <em class="parameter"><code>idx</code></em> nm_setting_wireless_add_mac_blacklist_item (<em class="parameter"><code><a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> *setting</code></em>, <em class="parameter"><code>const <span class="type">char</span> *mac</code></em>);</pre> -<p>Adds a new MAC address to the <a class="link" href="NMSettingWireless.html#NMSettingWireless--mac-address-blacklist" title="The “mac-address-blacklist” property"><span class="type">“mac-address-blacklist”</span></a> property.</p> +<p>Adds a new MAC address to the <a href="NMSettingWireless.html#NMSettingWireless--mac-address-blacklist"><span class="type">“mac-address-blacklist”</span></a> property.</p> <div class="refsect3"> <a name="nm-setting-wireless-add-mac-blacklist-item.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> @@ -1004,7 +887,7 @@ nm_setting_wireless_get_mtu (<em class="parameter"><code><a class="link" href="N </div> <div class="refsect3"> <a name="nm-setting-wireless-get-mtu.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--mtu" title="The “mtu” property"><span class="type">“mtu”</span></a> property of the setting</p> +<p> the <a href="NMSettingWireless.html#NMSettingWireless--mtu"><span class="type">“mtu”</span></a> property of the setting</p> </div> </div> <hr> @@ -1029,7 +912,7 @@ nm_setting_wireless_get_hidden (<em class="parameter"><code><a class="link" href </div> <div class="refsect3"> <a name="nm-setting-wireless-get-hidden.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--hidden" title="The “hidden” property"><span class="type">“hidden”</span></a> property of the setting</p> +<p> the <a href="NMSettingWireless.html#NMSettingWireless--hidden"><span class="type">“hidden”</span></a> property of the setting</p> </div> </div> <hr> @@ -1054,7 +937,7 @@ nm_setting_wireless_get_powersave (<em class="parameter"><code><a class="link" h </div> <div class="refsect3"> <a name="nm-setting-wireless-get-powersave.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--powersave" title="The “powersave” property"><span class="type">“powersave”</span></a> property of the setting</p> +<p> the <a href="NMSettingWireless.html#NMSettingWireless--powersave"><span class="type">“powersave”</span></a> property of the setting</p> </div> <p class="since">Since: 1.2</p> </div> @@ -1081,7 +964,7 @@ nm_setting_wireless_get_mac_address_randomization </div> <div class="refsect3"> <a name="nm-setting-wireless-get-mac-address-randomization.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--mac-address-randomization" title="The “mac-address-randomization” property"><span class="type">“mac-address-randomization”</span></a> property of the +<p> the <a href="NMSettingWireless.html#NMSettingWireless--mac-address-randomization"><span class="type">“mac-address-randomization”</span></a> property of the setting</p> </div> <p class="since">Since: 1.2</p> @@ -1300,7 +1183,7 @@ nm_setting_wireless_get_ap_isolation (<em class="parameter"><code><a class="link </div> <div class="refsect3"> <a name="nm-setting-wireless-get-ap-isolation.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingWireless.html#NMSettingWireless--ap-isolation" title="The “ap-isolation” property"><span class="type">“ap-isolation”</span></a> property of the setting</p> +<p> the <a href="NMSettingWireless.html#NMSettingWireless--ap-isolation"><span class="type">“ap-isolation”</span></a> property of the setting</p> </div> <p class="since">Since: 1.28</p> </div> @@ -1315,7 +1198,7 @@ nm_setting_wireless_get_ap_isolation (<em class="parameter"><code><a class="link <hr> <div class="refsect2"> <a name="NMSettingWirelessWakeOnWLan"></a><h3>enum NMSettingWirelessWakeOnWLan</h3> -<p>Options for <a class="link" href="NMSettingWireless.html#NMSettingWireless--wake-on-wlan" title="The “wake-on-wlan” property"><span class="type">“wake-on-wlan”</span></a>. Note that not all options +<p>Options for <a href="NMSettingWireless.html#NMSettingWireless--wake-on-wlan"><span class="type">“wake-on-wlan”</span></a>. Note that not all options are supported by all devices.</p> <div class="refsect3"> <a name="NMSettingWirelessWakeOnWLan.members"></a><h4>Members</h4> @@ -1619,285 +1502,6 @@ for this connection.</p> </table></div> </div> </div> -<hr> -<div class="refsect2"> -<a name="NMSettingWireless-struct"></a><h3>NMSettingWireless</h3> -<pre class="programlisting">typedef struct _NMSettingWireless NMSettingWireless;</pre> -<p>Wi-Fi Settings</p> -</div> -</div> -<div class="refsect1"> -<a name="NMSettingWireless.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="NMSettingWireless--ap-isolation"></a><h3>The <code class="literal">“ap-isolation”</code> property</h3> -<pre class="programlisting"> “ap-isolation” <a class="link" href="libnm-nm-dbus-interface.html#NMTernary" title="enum NMTernary"><span class="type">NMTernary</span></a></pre> -<p>Configures AP isolation, which prevents communication between -wireless devices connected to this AP. This property can be set -to a value different from <a class="link" href="libnm-nm-dbus-interface.html#NM-TERNARY-DEFAULT:CAPS"><code class="literal">NM_TERNARY_DEFAULT</code></a> only when the -interface is configured in AP mode.</p> -<p>If set to <a class="link" href="libnm-nm-dbus-interface.html#NM-TERNARY-TRUE:CAPS"><code class="literal">NM_TERNARY_TRUE</code></a>, 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.</p> -<p>If set to <a class="link" href="libnm-nm-dbus-interface.html#NM-TERNARY-FALSE:CAPS"><code class="literal">NM_TERNARY_FALSE</code></a>, devices can talk to each other.</p> -<p>When set to <a class="link" href="libnm-nm-dbus-interface.html#NM-TERNARY-DEFAULT:CAPS"><code class="literal">NM_TERNARY_DEFAULT</code></a>, the global default is used; in -case the global default is unspecified it is assumed to be -<a class="link" href="libnm-nm-dbus-interface.html#NM-TERNARY-FALSE:CAPS"><code class="literal">NM_TERNARY_FALSE</code></a>.</p> -<p>Owner: NMSettingWireless</p> -<p>Flags: Read / Write</p> -<p>Default value: NM_TERNARY_DEFAULT</p> -<p class="since">Since: 1.28</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingWireless--band"></a><h3>The <code class="literal">“band”</code> property</h3> -<pre class="programlisting"> “band” <span class="type">char</span> *</pre> -<p>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.</p> -<p>Owner: NMSettingWireless</p> -<p>Flags: Read / Write</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingWireless--bssid"></a><h3>The <code class="literal">“bssid”</code> property</h3> -<pre class="programlisting"> “bssid” <span class="type">char</span> *</pre> -<p>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.</p> -<p>Owner: NMSettingWireless</p> -<p>Flags: Read / Write</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingWireless--channel"></a><h3>The <code class="literal">“channel”</code> property</h3> -<pre class="programlisting"> “channel” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> -<p>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.</p> -<p>Owner: NMSettingWireless</p> -<p>Flags: Read / Write</p> -<p>Default value: 0</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingWireless--cloned-mac-address"></a><h3>The <code class="literal">“cloned-mac-address”</code> property</h3> -<pre class="programlisting"> “cloned-mac-address” <span class="type">char</span> *</pre> -<p>If specified, request that the device use this MAC address instead. -This is known as MAC cloning or spoofing.</p> -<p>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.</p> -<p>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).</p> -<p>On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated -"cloned-mac-address".</p> -<p>Owner: NMSettingWireless</p> -<p>Flags: Read / Write</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingWireless--generate-mac-address-mask"></a><h3>The <code class="literal">“generate-mac-address-mask”</code> property</h3> -<pre class="programlisting"> “generate-mac-address-mask” <span class="type">char</span> *</pre> -<p>With <a class="link" href="NMSettingWireless.html#NMSettingWireless--cloned-mac-address" title="The “cloned-mac-address” property"><span class="type">“cloned-mac-address”</span></a> 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.</p> -<p>If the property is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, it is eligible to be overwritten by a default -connection setting. If the value is still <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or an empty string, the -default is to create a locally-administered, unicast MAC address.</p> -<p>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.</p> -<p>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.</p> -<p>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.</p> -<p>Owner: NMSettingWireless</p> -<p>Flags: Read / Write</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingWireless--hidden"></a><h3>The <code class="literal">“hidden”</code> property</h3> -<pre class="programlisting"> “hidden” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> -<p>If <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, indicates that the network is a non-broadcasting network that -hides its SSID. This works both in infrastructure and AP mode.</p> -<p>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.</p> -<p>In AP mode, the created network does not broadcast its SSID.</p> -<p>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.</p> -<p>Owner: NMSettingWireless</p> -<p>Flags: Read / Write</p> -<p>Default value: FALSE</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingWireless--mac-address"></a><h3>The <code class="literal">“mac-address”</code> property</h3> -<pre class="programlisting"> “mac-address” <span class="type">char</span> *</pre> -<p>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).</p> -<p>Owner: NMSettingWireless</p> -<p>Flags: Read / Write</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingWireless--mac-address-blacklist"></a><h3>The <code class="literal">“mac-address-blacklist”</code> property</h3> -<pre class="programlisting"> “mac-address-blacklist” <a href="https://developer.gnome.org/glib/unstable/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></pre> -<p>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").</p> -<p>Owner: NMSettingWireless</p> -<p>Flags: Read / Write</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingWireless--mac-address-randomization"></a><h3>The <code class="literal">“mac-address-randomization”</code> property</h3> -<pre class="programlisting"> “mac-address-randomization” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> -<p>One of <a class="link" href="NMSetting.html#NM-SETTING-MAC-RANDOMIZATION-DEFAULT:CAPS"><code class="literal">NM_SETTING_MAC_RANDOMIZATION_DEFAULT</code></a> (never randomize unless -the user has set a global default to randomize and the supplicant -supports randomization), <a class="link" href="NMSetting.html#NM-SETTING-MAC-RANDOMIZATION-NEVER:CAPS"><code class="literal">NM_SETTING_MAC_RANDOMIZATION_NEVER</code></a> (never -randomize the MAC address), or <a class="link" href="NMSetting.html#NM-SETTING-MAC-RANDOMIZATION-ALWAYS:CAPS"><code class="literal">NM_SETTING_MAC_RANDOMIZATION_ALWAYS</code></a> -(always randomize the MAC address). This property is deprecated for -'cloned-mac-address'.</p> -<div class="warning"> -<p><code class="literal">NMSettingWireless:mac-address-randomization</code> has been deprecated since version 1.4 and should not be used in newly-written code.</p> -<p>Deprecated by NMSettingWireless:cloned-mac-address property.</p> -</div> -<p>Owner: NMSettingWireless</p> -<p>Flags: Read / Write</p> -<p>Default value: 0</p> -<p class="since">Since: 1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingWireless--mode"></a><h3>The <code class="literal">“mode”</code> property</h3> -<pre class="programlisting"> “mode” <span class="type">char</span> *</pre> -<p>Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, -infrastructure is assumed.</p> -<p>Owner: NMSettingWireless</p> -<p>Flags: Read / Write</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingWireless--mtu"></a><h3>The <code class="literal">“mtu”</code> property</h3> -<pre class="programlisting"> “mtu” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> -<p>If non-zero, only transmit packets of the specified size or smaller, -breaking larger packets up into multiple Ethernet frames.</p> -<p>Owner: NMSettingWireless</p> -<p>Flags: Read / Write</p> -<p>Default value: 0</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingWireless--powersave"></a><h3>The <code class="literal">“powersave”</code> property</h3> -<pre class="programlisting"> “powersave” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> -<p>One of <a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-POWERSAVE-DISABLE:CAPS"><code class="literal">NM_SETTING_WIRELESS_POWERSAVE_DISABLE</code></a> (disable Wi-Fi power -saving), <a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-POWERSAVE-ENABLE:CAPS"><code class="literal">NM_SETTING_WIRELESS_POWERSAVE_ENABLE</code></a> (enable Wi-Fi power -saving), <a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-POWERSAVE-IGNORE:CAPS"><code class="literal">NM_SETTING_WIRELESS_POWERSAVE_IGNORE</code></a> (don't touch currently -configure setting) or <a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-POWERSAVE-DEFAULT:CAPS"><code class="literal">NM_SETTING_WIRELESS_POWERSAVE_DEFAULT</code></a> (use the -globally configured value). All other values are reserved.</p> -<p>Owner: NMSettingWireless</p> -<p>Flags: Read / Write</p> -<p>Default value: 0</p> -<p class="since">Since: 1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingWireless--rate"></a><h3>The <code class="literal">“rate”</code> property</h3> -<pre class="programlisting"> “rate” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> -<p>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.</p> -<p>Owner: NMSettingWireless</p> -<p>Flags: Read / Write</p> -<p>Default value: 0</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingWireless--seen-bssids"></a><h3>The <code class="literal">“seen-bssids”</code> property</h3> -<pre class="programlisting"> “seen-bssids” <a href="https://developer.gnome.org/glib/unstable/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></pre> -<p>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.</p> -<p>Owner: NMSettingWireless</p> -<p>Flags: Read / Write</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingWireless--ssid"></a><h3>The <code class="literal">“ssid”</code> property</h3> -<pre class="programlisting"> “ssid” <a href="https://developer.gnome.org/glib/unstable/glib-Byte-Arrays.html#GBytes"><span class="type">GBytes</span></a> *</pre> -<p>SSID of the Wi-Fi network. Must be specified.</p> -<p>Owner: NMSettingWireless</p> -<p>Flags: Read / Write</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingWireless--tx-power"></a><h3>The <code class="literal">“tx-power”</code> property</h3> -<pre class="programlisting"> “tx-power” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> -<p>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.</p> -<p>Owner: NMSettingWireless</p> -<p>Flags: Read / Write</p> -<p>Default value: 0</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingWireless--wake-on-wlan"></a><h3>The <code class="literal">“wake-on-wlan”</code> property</h3> -<pre class="programlisting"> “wake-on-wlan” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> -<p>The <a class="link" href="NMSettingWireless.html#NMSettingWirelessWakeOnWLan" title="enum NMSettingWirelessWakeOnWLan"><span class="type">NMSettingWirelessWakeOnWLan</span></a> options to enable. Not all devices support all options. -May be any combination of <a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-WAKE-ON-WLAN-ANY:CAPS"><code class="literal">NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY</code></a>, -<a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-WAKE-ON-WLAN-DISCONNECT:CAPS"><code class="literal">NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT</code></a>, -<a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-WAKE-ON-WLAN-MAGIC:CAPS"><code class="literal">NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC</code></a>, -<a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-WAKE-ON-WLAN-GTK-REKEY-FAILURE:CAPS"><code class="literal">NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE</code></a>, -<a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-WAKE-ON-WLAN-EAP-IDENTITY-REQUEST:CAPS"><code class="literal">NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST</code></a>, -<a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-WAKE-ON-WLAN-4WAY-HANDSHAKE:CAPS"><code class="literal">NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE</code></a>, -<a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-WAKE-ON-WLAN-RFKILL-RELEASE:CAPS"><code class="literal">NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE</code></a>, -<a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-WAKE-ON-WLAN-TCP:CAPS"><code class="literal">NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP</code></a> or the special values -<a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-WAKE-ON-WLAN-DEFAULT:CAPS"><code class="literal">NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT</code></a> (to use global settings) and -<a class="link" href="NMSettingWireless.html#NM-SETTING-WIRELESS-WAKE-ON-WLAN-IGNORE:CAPS"><code class="literal">NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE</code></a> (to disable management of Wake-on-LAN in -NetworkManager).</p> -<p>Owner: NMSettingWireless</p> -<p>Flags: Read / Write</p> -<p>Default value: 1</p> -<p class="since">Since: 1.12</p> -</div> </div> </div> <div class="footer"> |