GNOME.org
 

[gnomeweb-wml] nm: settings documentation update

commit 414c86b48c886cfdb62ca2b3026882c0af4e515e
Author: Dan Williams <dcbw redhat com>
Date:   Thu Nov 12 07:56:19 2009 -0800

    nm: settings documentation update

 .../developers/settings-spec-08.html               |  152 ++++++++++----------
 1 files changed, 76 insertions(+), 76 deletions(-)
---
diff --git a/projects.gnome.org/NetworkManager/developers/settings-spec-08.html b/projects.gnome.org/NetworkManager/developers/settings-spec-08.html
index dadcdfb..39bcb33 100644
--- a/projects.gnome.org/NetworkManager/developers/settings-spec-08.html
+++ b/projects.gnome.org/NetworkManager/developers/settings-spec-08.html
@@ -157,7 +157,7 @@
 <td><strong>type</strong></td>
 <td>string</td>
 <td></td>
-<td>Either 'dun' or 'panu'</td>
+<td>Either 'dun' for Dial-Up Networking connections (not yet supported)  or 'panu' for Personal Area Networking connections.</td>
 </tr>
 </table><br/>
 <p><h2>Setting name: 'cdma'</h2></p>
@@ -176,19 +176,19 @@
 <td><strong>number</strong></td>
 <td>string</td>
 <td></td>
-<td>Number</td>
+<td>Number to dial when establishing a PPP data session with the CDMA-based mobile broadband network.  If not specified, the default number (#777) is used when required.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>username</strong></td>
 <td>string</td>
 <td></td>
-<td>Username</td>
+<td>Username used to authenticate with the network, if required.  Note that many providers do not require a username or accept any username.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>password</strong></td>
 <td>string</td>
 <td></td>
-<td>Password</td>
+<td>Password used to authenticate with the network, if required.  Note that many providers do not require a password or accept any password.</td>
 </tr>
 </table><br/>
 <p><h2>Setting name: 'connection'</h2></p>
@@ -256,37 +256,37 @@
 <td><strong>number</strong></td>
 <td>string</td>
 <td></td>
-<td>Number</td>
+<td>Number to dial when establishing a PPP data session with the GSM-based mobile broadband network.  In most cases, leave the number blank and a number selecting the APN specified in the 'apn' property will be used automatically when required.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>username</strong></td>
 <td>string</td>
 <td></td>
-<td>Username</td>
+<td>Username used to authenticate with the network, if required.  Note that many providers do not require a username or accept any username.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>password</strong></td>
 <td>string</td>
 <td></td>
-<td>Password</td>
+<td>Password used to authenticate with the network, if required.  Note that many providers do not require a password or accept any password.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>apn</strong></td>
 <td>string</td>
 <td></td>
-<td>APN</td>
+<td>The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network.  The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>network-id</strong></td>
 <td>string</td>
 <td></td>
-<td>Network ID (GSM LAI format)</td>
+<td>The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration.  If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network.  This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>network-type</strong></td>
 <td>int32</td>
 <td>0</td>
-<td>Network type</td>
+<td>Network preference to force the device to only use specific network technologies.  The permitted values are: -1: any, 0: 3G only, 1: GPRS/EDGE only, 2: prefer 3G, and 3: prefer 2G.  Note that not all devices allow network preference control.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>band</strong></td>
@@ -298,7 +298,7 @@
 <td><strong>pin</strong></td>
 <td>string</td>
 <td></td>
-<td>PIN</td>
+<td>If the SIM is locked with a PIN it must be unlocked before any other operations are requested.  Specify the PIN here to allow operation of the device.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>puk</strong></td>
@@ -310,7 +310,7 @@
 <td><strong>allowed-bands</strong></td>
 <td>uint32</td>
 <td>0</td>
-<td>Bitfield of allowed frequency bands</td>
+<td>Bitfield of allowed frequency bands.  Note that not all devices allow frequency band control.</td>
 </tr>
 </table><br/>
 <p><h2>Setting name: 'ipv4'</h2></p>
@@ -469,19 +469,19 @@
 <td><strong>ssid</strong></td>
 <td>byte array</td>
 <td></td>
-<td>SSID</td>
+<td>SSID of the mesh network to join.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>channel</strong></td>
 <td>uint32</td>
 <td>0</td>
-<td>Channel</td>
+<td>Channel on which the mesh network to join is located.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>dhcp-anycast-address</strong></td>
 <td>byte array</td>
 <td></td>
-<td>Anycast DHCP MAC address</td>
+<td>Anycast DHCP MAC address used when requesting an IP address via DHCP.  The specific anycast address used determines which DHCP server class answers the the request.</td>
 </tr>
 </table><br/>
 <p><h2>Setting name: 'ppp'</h2></p>
@@ -500,109 +500,109 @@
 <td><strong>noauth</strong></td>
 <td>boolean</td>
 <td>FALSE</td>
-<td>NoAuth</td>
+<td>If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client.  If FALSE, require authentication from the remote side.  In almost all cases, this should be TRUE.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>refuse-eap</strong></td>
 <td>boolean</td>
 <td>FALSE</td>
-<td>Refuse EAP</td>
+<td>If TRUE, the EAP authentication method will not be used.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>refuse-pap</strong></td>
 <td>boolean</td>
 <td>FALSE</td>
-<td>Refuse PAP</td>
+<td>If TRUE, the PAP authentication method will not be used.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>refuse-chap</strong></td>
 <td>boolean</td>
 <td>FALSE</td>
-<td>Refuse CHAP</td>
+<td>If TRUE, the CHAP authentication method will not be used.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>refuse-mschap</strong></td>
 <td>boolean</td>
 <td>FALSE</td>
-<td>Refuse MSCHAP</td>
+<td>If TRUE, the MSCHAP authentication method will not be used.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>refuse-mschapv2</strong></td>
 <td>boolean</td>
 <td>FALSE</td>
-<td>Refuse MSCHAPv2</td>
+<td>If TRUE, the MSCHAPv2 authentication method will not be used.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>nobsdcomp</strong></td>
 <td>boolean</td>
 <td>FALSE</td>
-<td>No BSD compression</td>
+<td>If TRUE, BSD compression will not be requested.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>nodeflate</strong></td>
 <td>boolean</td>
 <td>FALSE</td>
-<td>No deflate</td>
+<td>If TRUE, 'deflate' compression will not be requested.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>no-vj-comp</strong></td>
 <td>boolean</td>
 <td>FALSE</td>
-<td>No VJ compression</td>
+<td>If TRUE, Van Jacobsen TCP header compression will not be requested.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>require-mppe</strong></td>
 <td>boolean</td>
 <td>FALSE</td>
-<td>Require MPPE</td>
+<td>If TRUE, MPPE (Microsoft Point-to-Point Encrpytion) will be required for the PPP session.  If either 64-bit or 128-bit MPPE is not available the session will fail.  Note that MPPE is not used on mobile broadband connections.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>require-mppe-128</strong></td>
 <td>boolean</td>
 <td>FALSE</td>
-<td>Require MPPE 128</td>
+<td>If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encrpytion) will be required for the PPP session, and the 'require-mppe' property must also be set to TRUE.  If 128-bit MPPE is not available the session will fail.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>mppe-stateful</strong></td>
 <td>boolean</td>
 <td>FALSE</td>
-<td>MPPE stateful</td>
+<td>If TRUE, stateful MPPE is used.  See pppd documentation for more information on stateful MPPE.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>crtscts</strong></td>
 <td>boolean</td>
 <td>FALSE</td>
-<td>CRTSCTS</td>
+<td>If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals.  This value should normally be set to FALSE.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>baud</strong></td>
 <td>uint32</td>
 <td>0</td>
-<td>Baud</td>
+<td>If non-zero, instruct pppd to set the serial port to the specified baudrate.  This value should normally be left as 0 to automatically choose the speed.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>mru</strong></td>
 <td>uint32</td>
 <td>0</td>
-<td>MRU</td>
+<td>If non-zero, instruct pppd to request that the peer send packets no larger than the specified size.  If non-zero, the MRU should be between 128 and 16384.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>mtu</strong></td>
 <td>uint32</td>
 <td>0</td>
-<td>MTU</td>
+<td>If non-zero, instruct pppd to send packets no larger than the specified size.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>lcp-echo-failure</strong></td>
 <td>uint32</td>
 <td>0</td>
-<td>LCP echo failure</td>
+<td>If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer.  The 'lcp-echo-interval' property must also be set to a non-zero value if this property is used.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>lcp-echo-interval</strong></td>
 <td>uint32</td>
 <td>0</td>
-<td>LCP echo interval</td>
+<td>If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value).  Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.</td>
 </tr>
 </table><br/>
 <p><h2>Setting name: 'pppoe'</h2></p>
@@ -621,19 +621,19 @@
 <td><strong>service</strong></td>
 <td>string</td>
 <td></td>
-<td>Service</td>
+<td>If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified serivce.  For most providers, this should be left blank.  It is only required if there are multiple access concentrators or a specific service is known to be required.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>username</strong></td>
 <td>string</td>
 <td></td>
-<td>Username</td>
+<td>Username used to authenticate with the PPPoE service.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>password</strong></td>
 <td>string</td>
 <td></td>
-<td>Password</td>
+<td>Password used to authenticate with the PPPoE service.</td>
 </tr>
 </table><br/>
 <p><h2>Setting name: 'serial'</h2></p>
@@ -652,31 +652,31 @@
 <td><strong>baud</strong></td>
 <td>uint32</td>
 <td>0</td>
-<td>Baud rate</td>
+<td>Speed to use for communication over the serial port.  Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>bits</strong></td>
 <td>uint32</td>
 <td>0</td>
-<td>Bits</td>
+<td>Byte-width of the serial communication.  The 8 in '8n1' for example.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>parity</strong></td>
 <td>gchar</td>
 <td>0</td>
-<td>Parity</td>
+<td>Parity setting of the serial port.  Either 'E' for even parity, 'o' for odd parity, or 'n' for no parity.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>stopbits</strong></td>
 <td>uint32</td>
 <td>0</td>
-<td>Stopbits</td>
+<td>Number of stop bits for communication on the serial port.  Either 1 or 2.  The 1 in '8n1' for example.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>send-delay</strong></td>
 <td>uint64</td>
 <td>0</td>
-<td>Send delay</td>
+<td>Time to delay between each byte sent to the modem, in microseconds.</td>
 </tr>
 </table><br/>
 <p><h2>Setting name: 'vpn'</h2></p>
@@ -695,25 +695,25 @@
 <td><strong>service-type</strong></td>
 <td>string</td>
 <td></td>
-<td>Service type</td>
+<td>D-Bus service name of the VPN plugin that this setting uses to connect to its network.  i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>user-name</strong></td>
 <td>string</td>
 <td></td>
-<td>User name</td>
+<td>User name of the currently logged in user for connections provided by the user settings service.  This name is provided to the VPN plugin to use in lieu of a custom username provided by that VPN plugins specific configuration.  The VPN plugin itself decides which user name to use.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>data</strong></td>
 <td>dict of (string::string)</td>
 <td></td>
-<td>VPN Service specific data</td>
+<td>Dictionary of key/value pairs of VPN plugin specific data.  Both keys and values must be strings.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>secrets</strong></td>
 <td>dict of (string::string)</td>
 <td></td>
-<td>VPN Service specific secrets</td>
+<td>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys.  Both keys and values must be strings.</td>
 </tr>
 </table><br/>
 <p><h2>Setting name: '802-3-ethernet'</h2></p>
@@ -732,37 +732,37 @@
 <td><strong>port</strong></td>
 <td>string</td>
 <td></td>
-<td>Port type</td>
+<td>Specific port type to use if multiple the device supports multiple attachment methods.  One of 'tp' (Twisted Pair), 'aui' (Attachment Unit Interface), 'bnc' (Thin Ethernet) or 'mii' (Media Independent Interface.  If the device supports only one port type, this setting is ignored.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>speed</strong></td>
 <td>uint32</td>
 <td>0</td>
-<td>Speed</td>
+<td>If non-zero, request that the device use only the specified speed.  In Mbit/s, ie 100 == 100Mbit/s.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>duplex</strong></td>
 <td>string</td>
 <td></td>
-<td>Duplex</td>
+<td>If specified, request that the device only use the specified duplex mode.  Either 'half' or 'full'.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>auto-negotiate</strong></td>
 <td>boolean</td>
 <td>FALSE</td>
-<td>Auto negotiate</td>
+<td>If TRUE, allow auto-negotiation of port speed and duplex mode.  If FALSE, do not allow auto-negotiation,in which case the 'speed' and 'duplex' properties should be set.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>mac-address</strong></td>
 <td>byte array</td>
 <td></td>
-<td>Harware address</td>
+<td>If specified, this connection will only apply to the ethernet device whose MAC address matches.  This property does not change the MAC address of the device (known as MAC spoofing).</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>mtu</strong></td>
 <td>uint32</td>
 <td>0</td>
-<td>MTU</td>
+<td>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</td>
 </tr>
 </table><br/>
 <p><h2>Setting name: '802-11-wireless'</h2></p>
@@ -781,67 +781,67 @@
 <td><strong>ssid</strong></td>
 <td>byte array</td>
 <td></td>
-<td>SSID</td>
+<td>SSID of the WiFi network.  Must be specified.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>mode</strong></td>
 <td>string</td>
 <td></td>
-<td>Mode</td>
+<td>WiFi network mode; one of 'infrastructure' or 'adhoc'.  If blank, infrastructure is assumed.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>band</strong></td>
 <td>string</td>
 <td></td>
-<td>Band</td>
+<td>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 WiFi 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.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>channel</strong></td>
 <td>uint32</td>
 <td>0</td>
-<td>Channel</td>
+<td>Wireless channel to use for the WiFi connection.  The device will only join (or create for Ad-Hoc networks) a WiFi network on the specified channel.  Because channel numbers overlap between bands, this property also requires the 'band' property to be set.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>bssid</strong></td>
 <td>byte array</td>
 <td></td>
-<td>BSSID</td>
+<td>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.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>rate</strong></td>
 <td>uint32</td>
 <td>0</td>
-<td>Rate</td>
+<td>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.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>tx-power</strong></td>
 <td>uint32</td>
 <td>0</td>
-<td>TX Power</td>
+<td>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.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>mac-address</strong></td>
 <td>byte array</td>
 <td></td>
-<td>Harware address</td>
+<td>If specified, this connection will only apply to the WiFi device whose MAC address matches.  This property does not change the MAC address of the device (known as MAC spoofing).</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>mtu</strong></td>
 <td>uint32</td>
 <td>0</td>
-<td>MTU</td>
+<td>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>seen-bssids</strong></td>
 <td>array of string</td>
 <td></td>
-<td>Seen BSSIDs</td>
+<td>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 WiFI network.  The settings service will usually populate this property by periodically asking NetworkManager what the device's current AP is while connected to the network (or monitoring the device's 'active-ap' property) and adding the current AP's BSSID to this list.  This list helps NetworkManager find hidden APs by matching up scan results with the BSSIDs in this list.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>security</strong></td>
 <td>string</td>
 <td></td>
-<td>Security</td>
+<td>If the wireless connection has any security restrictions, like 802.1x, WEP, or WPA, set this property to '802-11-wireless-security' and ensure the connection contains a valid 802-11-wireless-security setting.</td>
 </tr>
 </table><br/>
 <p><h2>Setting name: '802-11-wireless-security'</h2></p>
@@ -860,85 +860,85 @@
 <td><strong>key-mgmt</strong></td>
 <td>string</td>
 <td></td>
-<td>Key management</td>
+<td>Key management used for the connection.  One of 'none' (WEP), 'ieee8021x' (Dynamic WEP), 'wpa-none' (WPA-PSK Ad-Hoc), 'wpa-psk' (infrastructure WPA-PSK), or 'wpa-eap' (WPA-Enterprise).  This property must be set for any WiFi connection that uses security.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>wep-tx-keyidx</strong></td>
 <td>uint32</td>
 <td>0</td>
-<td>WEP TX key index</td>
+<td>When static WEP is used (ie, key-mgmt = 'none') and a non-default WEP key index is used by the AP, put that WEP key index here.  Valid values are 0 (default key) through 3.  Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>auth-alg</strong></td>
 <td>string</td>
 <td></td>
-<td>AuthAlg</td>
+<td>When WEP is used (ie, key-mgmt = 'none' or 'ieee8021x') indicate the 802.11 authentication algorithm required by the AP here.  One of 'open' for Open System, 'shared' for Shared Key, or 'leap' for Cisco LEAP.  When using Cisco LEAP (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap') the 'leap-username' and 'leap-password' properties must be specified.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>proto</strong></td>
 <td>array of string</td>
 <td></td>
-<td>Proto</td>
+<td>List of strings specifying the allowed WPA protocol versions to use.  Each element may be one 'wpa' (allow WPA) or 'rsn' (allow WPA2/RSN).  If not specified, both WPA and RSN connections are allowed.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>pairwise</strong></td>
 <td>array of string</td>
 <td></td>
-<td>Pairwise</td>
+<td>If specified, will only connect to WPA networks that provide the specified pairwise encryption capabilities.  Each element may be one of 'wep40', 'wep104', 'tkip', or 'ccmp'.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>group</strong></td>
 <td>array of string</td>
 <td></td>
-<td>Group</td>
+<td>If specified, will only connect to WPA networks that provide the specified group/multicast encryption capabilities.  Each element may be one of 'wep40', 'wep104', 'tkip', or 'ccmp'.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>leap-username</strong></td>
 <td>string</td>
 <td></td>
-<td>LEAP Username</td>
+<td>The login username for legacy LEAP connections (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>wep-key0</strong></td>
 <td>string</td>
 <td></td>
-<td>WEP key0</td>
+<td>Index 0 WEP key.  This is the WEP key used in most networks.  See the 'wep-key-type' property for a description of how this key is interpreted.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>wep-key1</strong></td>
 <td>string</td>
 <td></td>
-<td>WEP key1</td>
+<td>Index 1 WEP key.  This WEP index is not used by most networks.  See the 'wep-key-type' property for a description of how this key is interpreted.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>wep-key2</strong></td>
 <td>string</td>
 <td></td>
-<td>WEP key2</td>
+<td>Index 2 WEP key.  This WEP index is not used by most networks.  See the 'wep-key-type' property for a description of how this key is interpreted.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>wep-key3</strong></td>
 <td>string</td>
 <td></td>
-<td>WEP key3</td>
+<td>Index 3 WEP key.  This WEP index is not used by most networks.  See the 'wep-key-type' property for a description of how this key is interpreted.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>psk</strong></td>
 <td>string</td>
 <td></td>
-<td>PSK</td>
+<td>Pre-Shared-Key for WPA networks.  If the key is 64-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key.  Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA-PSK used when connecting to the WiFi network.</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>leap-password</strong></td>
 <td>string</td>
 <td></td>
-<td>LEAP Password</td>
+<td>The login password for legacy LEAP connections (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').</td>
 </tr>
 <tr align=left valign=top>
 <td><strong>wep-key-type</strong></td>
 <td>uint32</td>
 <td>0</td>
-<td>WEP Key Type</td>
+<td>Controls the interpretation of WEP keys.  Allowed values are 1 (interpret WEP keys as hexadecimal or ASCII keys) or 2 (interpret WEP keys as WEP Passphrases).  If set to 1 and the keys are hexadecimal, they must be either 10 or 26 characters in length.  If set to 1 and the keys are ASCII keys, they must be either 5 or 13 characters in length.  If set to 2, the passphrase is hashed using  the de-facto MD5 method to derive the actual WEP key.</td>
 </tr>
 </table><br/>
 </body>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]