Share via

Provisioning XML Document for Wi-Fi Configuration Service Provider (Compact 2013)

  • Article

3/26/2014

Configuration Manager uses this XML document to configure Wi-Fi settings for a Windows Embedded Compact powered device.

Syntax

<wap-provisioningdoc>
    <characteristic type="Wi-Fi">
        <characteristic type="<NetworkType>">
            <characteristic type="<NetworkName>">
                <parm name="<ParmName>" value="<ParmValue>" />
                <parm-query name="<ParmName>" />
                <noparm name="<ParmName>" />
            </characteristic>
        </characteristic>
        <characteristic-query type="<NetworkName>" />
        <nocharacteristic type="<NetworkName>" />
    </characteristic>
</wap-provisioningdoc>

Elements

Element name

Description

Attributes

characteristic

Groups settings for a configuration service provider.
type

The type of group. It can be one of the following:

ValueDescription
Wi-FiIndicates the root characteristic element for the Wi-Fi configuration service provider.
access-pointSpecifies access-point (infrastructure mode) network types.
ad-hocSpecifies device-to-device network type.
<network_name>Specifies the name of the access-point or ad-hoc network to create, configure, query, or delete. A name can correspond to a service set identifier (SSID).

parm

Metadata that describes a device setting.
name

The name of the device setting to configure. It can be one of the following:

ValueDescription
Authentication
The Wi-Fi authentication method for the network. When used, the corresponding value attribute can be one of the following possible values:

ValueDescription
0 Open authentication mode (default).
1Shared authentication mode.
3Wi-Fi Protected Access (WPA) authentication. Valid for access-point connections.
4WPA-PSK authentication mode; WAP in combination with a preshared key. Valid for access-point connections.
5WPA-NONE. Valid for ad hoc connections.
DestId
The GUID for the destination network. When used, the corresponding value attribute can be one of the following possible values.

ValueDescription
"{436EF144-B4FB-4863-A041-8F905A62C572}"The Internet (default)
"{A1182988-0D73-439e-87AD-2A5B369F808B}"Work
EAPType
The Extensible Authentication Protocol (EAP) plug-in driver to use for the network. When used, the corresponding value attribute is a valid identifier for an EAP plug-in that was installed on the device, as specified in the registry. The following table shows the possible values:

ValueDescription
13Certificate (EAP-TLS)
25Protected EAP (PEAP) (default)
Encryption
The encryption technique of the network. When used, the corresponding value attribute can be one of the following possible values:

ValueDescription
0Encrypt by using 802.11 wired equivalent privacy (WEP) key. (default)
1No encryption.
4Encrypt by using Temporal Key Integrity Protocol (TKIP) sequence counters.
Filter
The filter mode for the Wi-Fi hardware. When used, the corresponding value attribute can be one of the following possible values:

ValueDescription
0Allows connection only to device-to-device (ad hoc) networks.
1Allows connection only to access point networks.
2Allows connection to all available networks. (default)
Hidden
Indicates whether the network is hidden. When used, the corresponding value attribute can be one of the following possible values:

ValueDescription
0The network is considered a regular broadcast network. (default)
1Hides the network. The adapter must search for it to be able to connect.
KeyIndex
The network key index. When used, the corresponding value attribute can be any integer value from 1 to 4. The default value is 1.
Gg155011.note(en-us,WinEmbedded.80).gifNote:
This value only applies to WEP-encrypted networks.
KeyProvidedTurns on or off the Wi-Fi network automatic key flag. When used, the corresponding value attribute can be either 0 (zero) or 1. A value of 1 indicates the automatic key is turned on, and a value of 0 (zero) indicates the automatic key is turned off.
NetworkKey
The network key in ASCII or hexadecimal. The maximum length of this string value is 64 characters.
Gg155011.note(en-us,WinEmbedded.80).gifNote:
This value is stored and sent as plain text. You should make sure that you transmit XML that contains this setting in a secure manner because access to the XML provides access to the network key.
Use8021xThe Wi-Fi network 802.1X flag. When used, the corresponding value attribute turns on or off the Wi-Fi network 802.1X flag. A value of 1 indicates 802.1X is turned on, and a value of 0 (zero) indicates 802.1X is turned off.
value

See descriptions in name attribute for possible values.

parm-query

Specifies a request for the current value of a setting.
name

Any supported name attribute that is listed above.

value

On return, contains the value of the setting provided in name.

noparm

In a request document, a setting to be removed.
name

Any supported name attribute that is listed above.

nocharacteristic

In a request document, the settings to be removed from the device.
type

Any supported type attribute that is listed above.

characteristic-query

Use this element to query the setting values specified by the characteristic in the type attribute.
type

Any supported type attribute that is listed above.

Remarks

To accept XML for this configuration service provider, the Windows Embedded Compact powered device must have a Wi-Fi driver that is either powered on or is in a suspended state.

To configure Wi-Fi settings, you can write a Open Mobile Alliance Client Provisioning (OMA CP) XML file that you customize for the Wi-Fi configuration service provider. However, the Wi-Fi configuration service provider supports only a subset of elements and its own attribute values for the characteristic and parm elements.

For more information about elements, see Provisioning XML Document.

Example

The following code example creates a new Wi-Fi connection to a network named "Proseware, Inc." that has specific settings for authentication, encryption, and 802.11.

Important

For readability, the following code example does not contain security checking or error handling. Do not use the following code in a production environment.

<wap-provisioningdoc>
    <characteristic type="Wi-Fi">
        <characteristic type="access-point">
            <characteristic type="Proseware">
                <parm name="Authentication" value="0"/>
                <parm name="Encryption" value="0"/>
                <parm name="Use8021x" value="true"/>
            </characteristic>
        </characteristic>
    </characteristic>
</wap-provisioningdoc>

Requirements

sysgen

SYSGEN_DMSRV,
SYSGEN_ETH_80211_NWIFI

See Also

Reference

Configuration Service Provider Reference
IConfigManager