Windows Dev Center

WLANProfile Element

The WLANProfile element contains a wireless LAN profile. This element is the unique root element for a wireless profile.

The target namespace for the WLANProfile element is http://www.microsoft.com/networking/WLAN/profile/v1.

<xs:element name="WLANProfile">
    <xs:complexType>
        <xs:sequence>
            <xs:element name="name"
                type="nameType"
             />
            <xs:element name="SSIDConfig"
                maxOccurs="256"
            >
                <xs:complexType>
                    <xs:sequence>
                        <xs:element name="SSID"
                            maxOccurs="256"
                        >
                            <xs:complexType>
                                <xs:sequence>
                                    <xs:element name="hex"
                                        minOccurs="0"
                                    >
                                        <xs:simpleType>
                                            <xs:restriction
                                                base="hexBinary"
                                            >
                                                <xs:minLength
                                                    value="1"
                                                 />
                                                <xs:maxLength
                                                    value="32"
                                                 />
                                            </xs:restriction>
                                        </xs:simpleType>
                                    </xs:element>
                                    <xs:element name="name"
                                        minOccurs="0"
                                    >
                                        <xs:simpleType>
                                            <xs:restriction
                                                base="string"
                                            >
                                                <xs:minLength
                                                    value="1"
                                                 />
                                                <xs:maxLength
                                                    value="32"
                                                 />
                                            </xs:restriction>
                                        </xs:simpleType>
                                    </xs:element>
                                    <xs:any
                                        processContents="lax"
                                        minOccurs="0"
                                        maxOccurs="unbounded"
                                        namespace="##other"
                                     />
                                </xs:sequence>
                            </xs:complexType>
                        </xs:element>
                        <xs:element name="nonBroadcast"
                            type="boolean"
                            minOccurs="0"
                         />
                        <xs:any
                            processContents="lax"
                            minOccurs="0"
                            maxOccurs="unbounded"
                            namespace="##other"
                         />
                    </xs:sequence>
                </xs:complexType>
            </xs:element>
            <xs:element name="connectionType">
                <xs:simpleType>
                    <xs:restriction
                        base="string"
                    >
                        <xs:enumeration
                            value="IBSS"
                         />
                        <xs:enumeration
                            value="ESS"
                         />
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="connectionMode"
                minOccurs="0"
            >
                <xs:simpleType>
                    <xs:restriction
                        base="string"
                    >
                        <xs:enumeration
                            value="auto"
                         />
                        <xs:enumeration
                            value="manual"
                         />
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="autoSwitch"
                type="boolean"
                minOccurs="0"
             />
            <xs:any
                processContents="lax"
                minOccurs="0"
                maxOccurs="unbounded"
                namespace="##other"
             />
            <xs:element name="MSM"
                minOccurs="0"
            >
                <xs:complexType>
                    <xs:sequence>
                        <xs:element name="connectivity"
                            minOccurs="0"
                        >
                            <xs:complexType>
                                <xs:sequence>
                                    <xs:element name="phyType"
                                        minOccurs="0"
                                        maxOccurs="4"
                                    >
                                        <xs:simpleType>
                                            <xs:restriction
                                                base="string"
                                            >
                                                <xs:enumeration
                                                    value="a"
                                                 />
                                                <xs:enumeration
                                                    value="b"
                                                 />
                                                <xs:enumeration
                                                    value="g"
                                                 />
                                                <xs:enumeration
                                                    value="n"
                                                 />
                                            </xs:restriction>
                                        </xs:simpleType>
                                    </xs:element>
                                    <xs:any
                                        processContents="lax"
                                        minOccurs="0"
                                        maxOccurs="unbounded"
                                        namespace="##other"
                                     />
                                </xs:sequence>
                            </xs:complexType>
                        </xs:element>
                        <xs:element name="security"
                            minOccurs="0"
                        >
                            <xs:complexType>
                                <xs:sequence>
                                    <xs:element name="authEncryption">
                                        <xs:complexType>
                                            <xs:sequence>
                                                <xs:element name="authentication">
                                                    <xs:simpleType>
                                                        <xs:restriction
                                                            base="string"
                                                        >
                                                            <xs:enumeration
                                                                value="open"
                                                             />
                                                            <xs:enumeration
                                                                value="shared"
                                                             />
                                                            <xs:enumeration
                                                                value="WPA"
                                                             />
                                                            <xs:enumeration
                                                                value="WPAPSK"
                                                             />
                                                            <xs:enumeration
                                                                value="WPA2"
                                                             />
                                                            <xs:enumeration
                                                                value="WPA2PSK"
                                                             />
                                                        </xs:restriction>
                                                    </xs:simpleType>
                                                </xs:element>
                                                <xs:element name="encryption">
                                                    <xs:simpleType>
                                                        <xs:restriction
                                                            base="string"
                                                        >
                                                            <xs:enumeration
                                                                value="none"
                                                             />
                                                            <xs:enumeration
                                                                value="WEP"
                                                             />
                                                            <xs:enumeration
                                                                value="TKIP"
                                                             />
                                                            <xs:enumeration
                                                                value="AES"
                                                             />
                                                        </xs:restriction>
                                                    </xs:simpleType>
                                                </xs:element>
                                                <xs:element name="useOneX"
                                                    type="boolean"
                                                    minOccurs="0"
                                                 />
                                                <xs:any
                                                    processContents="lax"
                                                    minOccurs="0"
                                                    maxOccurs="unbounded"
                                                    namespace="##other"
                                                 />
                                            </xs:sequence>
                                        </xs:complexType>
                                    </xs:element>
                                    <xs:element name="sharedKey"
                                        minOccurs="0"
                                    >
                                        <xs:complexType>
                                            <xs:sequence>
                                                <xs:element name="keyType">
                                                    <xs:simpleType>
                                                        <xs:restriction
                                                            base="string"
                                                        >
                                                            <xs:enumeration
                                                                value="networkKey"
                                                             />
                                                            <xs:enumeration
                                                                value="passPhrase"
                                                             />
                                                        </xs:restriction>
                                                    </xs:simpleType>
                                                </xs:element>
                                                <xs:element name="protected"
                                                    type="boolean"
                                                 />
                                                <xs:element name="keyMaterial"
                                                    type="string"
                                                 />
                                                <xs:any
                                                    processContents="lax"
                                                    minOccurs="0"
                                                    maxOccurs="unbounded"
                                                    namespace="##other"
                                                 />
                                            </xs:sequence>
                                        </xs:complexType>
                                    </xs:element>
                                    <xs:element name="keyIndex"
                                        minOccurs="0"
                                    >
                                        <xs:simpleType>
                                            <xs:restriction
                                                base="integer"
                                            >
                                                <xs:minInclusive
                                                    value="0"
                                                 />
                                                <xs:maxInclusive
                                                    value="3"
                                                 />
                                            </xs:restriction>
                                        </xs:simpleType>
                                    </xs:element>
                                    <xs:element name="PMKCacheMode"
                                        minOccurs="0"
                                    >
                                        <xs:simpleType>
                                            <xs:restriction
                                                base="string"
                                            >
                                                <xs:enumeration
                                                    value="disabled"
                                                 />
                                                <xs:enumeration
                                                    value="enabled"
                                                 />
                                            </xs:restriction>
                                        </xs:simpleType>
                                    </xs:element>
                                    <xs:element name="PMKCacheTTL"
                                        minOccurs="0"
                                    >
                                        <xs:simpleType>
                                            <xs:restriction
                                                base="integer"
                                            >
                                                <xs:minInclusive
                                                    value="5"
                                                 />
                                                <xs:maxInclusive
                                                    value="1400"
                                                 />
                                            </xs:restriction>
                                        </xs:simpleType>
                                    </xs:element>
                                    <xs:element name="PMKCacheSize"
                                        minOccurs="0"
                                    >
                                        <xs:simpleType>
                                            <xs:restriction
                                                base="integer"
                                            >
                                                <xs:minInclusive
                                                    value="1"
                                                 />
                                                <xs:maxInclusive
                                                    value="255"
                                                 />
                                            </xs:restriction>
                                        </xs:simpleType>
                                    </xs:element>
                                    <xs:element name="preAuthMode"
                                        minOccurs="0"
                                    >
                                        <xs:simpleType>
                                            <xs:restriction
                                                base="string"
                                            >
                                                <xs:enumeration
                                                    value="disabled"
                                                 />
                                                <xs:enumeration
                                                    value="enabled"
                                                 />
                                            </xs:restriction>
                                        </xs:simpleType>
                                    </xs:element>
                                    <xs:element name="preAuthThrottle"
                                        minOccurs="0"
                                    >
                                        <xs:simpleType>
                                            <xs:restriction
                                                base="integer"
                                            >
                                                <xs:minInclusive
                                                    value="1"
                                                 />
                                                <xs:maxInclusive
                                                    value="16"
                                                 />
                                            </xs:restriction>
                                        </xs:simpleType>
                                    </xs:element>
                                    <xs:any
                                        processContents="lax"
                                        minOccurs="0"
                                        maxOccurs="unbounded"
                                        namespace="##other"
                                     />
                                </xs:sequence>
                            </xs:complexType>
                        </xs:element>
                        <xs:any
                            processContents="lax"
                            minOccurs="0"
                            maxOccurs="unbounded"
                            namespace="##other"
                         />
                    </xs:sequence>
                </xs:complexType>
            </xs:element>
            <xs:element name="IHV"
                minOccurs="0"
            >
                <xs:complexType>
                    <xs:sequence>
                        <xs:element name="OUIHeader">
                            <xs:complexType>
                                <xs:sequence>
                                    <xs:element name="OUI">
                                        <xs:simpleType>
                                            <xs:restriction
                                                base="hexBinary"
                                            >
                                                <xs:length
                                                    value="3"
                                                 />
                                            </xs:restriction>
                                        </xs:simpleType>
                                    </xs:element>
                                    <xs:element name="type">
                                        <xs:simpleType>
                                            <xs:restriction
                                                base="hexBinary"
                                            >
                                                <xs:length
                                                    value="1"
                                                 />
                                            </xs:restriction>
                                        </xs:simpleType>
                                    </xs:element>
                                    <xs:any
                                        processContents="lax"
                                        minOccurs="0"
                                        maxOccurs="unbounded"
                                        namespace="##other"
                                     />
                                </xs:sequence>
                            </xs:complexType>
                        </xs:element>
                        <xs:element name="connectivity"
                            minOccurs="0"
                        >
                            <xs:complexType>
                                <xs:sequence>
                                    <xs:any
                                        processContents="lax"
                                        namespace="##other"
                                     />
                                </xs:sequence>
                            </xs:complexType>
                        </xs:element>
                        <xs:element name="security"
                            minOccurs="0"
                        >
                            <xs:complexType>
                                <xs:sequence>
                                    <xs:any
                                        processContents="lax"
                                        namespace="##other"
                                     />
                                </xs:sequence>
                            </xs:complexType>
                        </xs:element>
                        <xs:element name="useMSOneX"
                            type="boolean"
                            minOccurs="0"
                         />
                        <xs:any
                            processContents="lax"
                            minOccurs="0"
                            maxOccurs="unbounded"
                            namespace="##other"
                         />
                    </xs:sequence>
                </xs:complexType>
            </xs:element>
            <xs:any
                processContents="lax"
                minOccurs="0"
                maxOccurs="unbounded"
                namespace="##other"
             />
        </xs:sequence>
    </xs:complexType>
</xs:element>

Child elements

ElementTypeDescription
authEncryption

Specifies the authentication and encryption pair to be used for this profile.

authentication

Specifies the authentication method to be used to connect to the wireless LAN.

autoSwitch boolean

Determines the roaming behavior of an auto-connected network when a more preferred network is in range. This element is optional and has no effect on a manually connected network.

Windows XP with SP3 and Wireless LAN API for Windows XP with SP2:  This element is not supported.

connectionMode

Indicates whether connection to the wireless LAN should be automatic ("auto") or initiated ("manual") by user. This element is optional.

connectionType

Indicates whether the network is infrastructure ("ESS") or ad-hoc ("IBSS").

connectivity

Contains various connectivity settings. This element is optional.

connectivity

Contains IHV-related connectivity settings.

Windows XP with SP3 and Wireless LAN API for Windows XP with SP2:  This element is not supported.

encryption

Sets the data encryption to use to connect to the wireless LAN.

hex

Contains the SSID of a wireless LAN in hexadecimal format.

IHV

Contains optional independent hardware vendor (IHV) settings.

Windows XP with SP3 and Wireless LAN API for Windows XP with SP2:  This element is not supported.

keyIndex

Specifies which key index should be used to encrypt wireless traffic. This is only used when keyType is set to "networkKey".

keyMaterial string

Contains the network key or passphrase.

keyType

Type of key.

MSM

Contains various MSM settings. This element is optional.

name nameType

Name of the WLAN profile.

name

Contains the SSID of a wireless LAN.

nonBroadcast boolean

Indicates whether the network broadcasts its SSID.

Windows XP with SP3 and Wireless LAN API for Windows XP with SP2:  This element is not supported.

OUI

Contains a 3 byte hexBinary that identifies the IHV.

Windows XP with SP3 and Wireless LAN API for Windows XP with SP2:  This element is not supported.

OUIHeader

Identifies the IHV.

Windows XP with SP3 and Wireless LAN API for Windows XP with SP2:  This element is not supported.

phyType

Specifies the 802.11 wireless LAN standard used on the wireless LAN. The value "n" is only supported on Windows Vista with SP1 and later versions of the operating system.

Windows XP with SP3 and Wireless LAN API for Windows XP with SP2:  This element is not supported.

PMKCacheMode

Indicates whether PMK caching will be used. This element is valid only for WPA2-defined networks.

Windows XP with SP3 and Wireless LAN API for Windows XP with SP2:  This element is not supported.

PMKCacheSize

Specifies the number of entries in the PMK cache on the client. This element is valid only for WPA2-defined networks with PMKCacheMode set to "enabled". If PMKCacheMode is enabled, and this element is absent, the size of the cache defaults to 128 entries.

Windows XP with SP3 and Wireless LAN API for Windows XP with SP2:  This element is not supported.

PMKCacheTTL

Indicates the length of time, in minutes, that a PMK cache will be kept. This element is valid only for WPA2-defined networks with PMKCacheMode set to "enabled".

Windows XP with SP3 and Wireless LAN API for Windows XP with SP2:  This element is not supported.

preAuthMode

Determines if pre-authentication will be used by the client. Pre-authentication enables WPA2 secure fast roaming. This element is valid only for WPA2-defined networks with PMKCacheMode set to "enabled". If PMKCacheMode is enabled, and this element is absent, the default value is disabled.

Windows XP with SP3 and Wireless LAN API for Windows XP with SP2:  This element is not supported.

preAuthThrottle

Indicates the number of tries when preauthenticating to neighboring APs. This element is valid only for WPA2-defined networks with PMKCacheMode set to "enabled". If PMKCacheMode is enabled, and this element is absent, the number of tries defaults to 3.

Windows XP with SP3 and Wireless LAN API for Windows XP with SP2:  This element is not supported.

protected boolean

Indicates whether the key is encrypted.

Windows XP with SP3 and Wireless LAN API for Windows XP with SP2:  This element must have a value of FALSE.

security

Contains various security settings. This element is optional.

security

Contains IHV-specific security settings. Microsoft security settings and IHV security settings are mutually exclusive. If both sets of security settings are present in the same profile, the profile is invalid.

Windows XP with SP3 and Wireless LAN API for Windows XP with SP2:  This element is not supported.

sharedKey

Contains the shared key information. This element is only required if WEP or PSK keys are required for the authentication and encryption pair.

SSID

Specifies the SSID of a wireless LAN.

SSIDConfig

Contains one or more SSIDs along with other common settings.

A profile can have multiple SSIDConfig elements and each SSIDConfig element can have multiple SSID elements. However, Windows only ever considers the first SSIDConfig element in a WLANProfile element.

Windows XP with SP3 and Wireless LAN API for Windows XP with SP2:  At most one SSID element can appear in a profile.

type

Contains a 1 byte hexBinary that is used to differentiate NICs by the same IHV.

Windows XP with SP3 and Wireless LAN API for Windows XP with SP2:  This element is not supported.

useMSOneX boolean

Specifies the origin of 802.1X security settings used by an IHV security component. When useMSOneX is true, IHV security components use Microsoft-defined 802.1X settings. When useMSOneX is false, IHV security components use vendor-supplied 802.1X settings. By default, useMSOneX is false. This element is optional.

useOneX boolean

Indicates whether 802.1X is used. This flag is optional.

Remarks

Most child elements of the WLANProfile element are in the http://www.microsoft.com/networking/WLAN/profile/v1 namespace. There are two exceptions: the FIPSMode element is in the http://www.microsoft.com/networking/WLAN/profile/v2 namespace and the OneX element is in the http://www.microsoft.com/networking/OneX/v1 namespace.

The FIPSMode element can be inserted as a child of the authEncryption element. The OneX element can be inserted as a child of the security (MSM) element.

To view the list of child elements in a tree-like structure, see WLAN_profile Schema Elements.

Examples

To view sample profiles, see Wireless Profile Samples.

Requirements

Minimum supported client

Windows Vista, Windows XP with SP3 [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Redistributable

Wireless LAN API for Windows XP with SP2

See also

Wireless Profile Samples

 

 

Community Additions

ADD
Show:
© 2015 Microsoft