Wi-Fi DDF File

4/8/2010

This topic shows the Device Description Framework (DDF) file for the Wi-Fi Configuration Service Provider. Open Mobile Alliance Device Management (OMA DM) DDF files and the example in this topic are used only for OMA DM provisioning. For more information, see OMA Device Management.

Note

The first line of the DDF is the namespace reference for Microsoft custom properties. For more information, see Managing Microsoft Custom Properties (OMA DM).

<MgmtTree xmlns:MSFT="https://schemas.microsoft.com/MobileDevice/DM">
    <VerDTD>1.2</VerDTD>
    <Node>
        <NodeName>Wi-Fi</NodeName>
        <Path>./Vendor/MSFT</Path>
        <DFProperties>
            <AccessType>
                <Get />
            </AccessType>
            <DFFormat>
                <node />
            </DFFormat>
            <Occurrence>
                <One />
            </Occurrence>
            <Scope>
                <Permanent />
            </Scope>
            <Description></Description>
        </DFProperties>
        <Node>
            <NodeName>ad-hoc</NodeName>
            <DFProperties>
                <AccessType>
                    <Get />
                </AccessType>
                <DFFormat>
                    <node />
                </DFFormat>
                <Occurrence>
                    <One />
                </Occurrence>
                <Scope>
                    <Permanent />
                </Scope>
                <Description>Wi-Fi network type (ad-hoc or access-point)</Description>
            </DFProperties>
            <Node>
                <NodeName></NodeName>
                <DFProperties>
                    <AccessType>
                        <Add />
                        <Get />
                        <Delete />
                    </AccessType>
                    <DFFormat>
                        <node />
                    </DFFormat>
                    <Occurrence>
                        <ZeroOrMore />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <Description>To provision correctly, Add the network name you want, then Replace
                        default values for EAPType, KeyIndex, Authentication, etc
                    </Description>
                </DFProperties>
                <Node>
                    <NodeName>EAPType</NodeName>
                    <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <int />
                        </DFFormat>
                        <Occurrence>
                            <One />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <DFTitle>EAP type:</DFTitle>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <Description>The Wi-Fi network EAP type (13 = SmartCard or Certificate; 25 = Protected EAP)</Description>
                    </DFProperties>
                </Node>
                <Node>
                    <NodeName>KeyIndex</NodeName>
                    <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <int />
                        </DFFormat>
                        <Occurrence>
                            <One />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <DFTitle>Key index:</DFTitle>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <MSFT:MinValue>1</MSFT:MinValue>
                        <MSFT:MaxValue>4</MSFT:MaxValue>
                        <Description>The Wi-Fi network key index</Description>
                    </DFProperties>
                </Node>
                <Node>
                    <NodeName>Authentication</NodeName>
                    <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <int />
                        </DFFormat>
                        <Occurrence>
                            <One />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <DFTitle>Authentication:</DFTitle>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <Description>The Wi-Fi authentication method (0 = Open, 1 = Shared, 5 = WPA-NONE)</Description>
                    </DFProperties>
                </Node>
                <Node>
                    <NodeName>Encryption</NodeName>
                    <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <int />
                        </DFFormat>
                        <Occurrence>
                            <One />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <DFTitle>Data encryption:</DFTitle>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <Description>The Wi-Fi network data encryption standard (0 = WEP, 1 = None, 4 = TKIP)</Description>
                    </DFProperties>
                </Node>
                <Node>
                    <NodeName>DestId</NodeName>
                    <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <chr />
                        </DFFormat>
                        <Occurrence>
                            <One />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <DFTitle>Network type:</DFTitle>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <Description>Destination Network</Description>
                    </DFProperties>
                </Node>
                <Node>
                    <NodeName>AdHoc</NodeName>
                    <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <bool />
                        </DFFormat>
                        <Occurrence>
                            <One />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <DFTitle>This is a device to device (ad-hoc) connection</DFTitle>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <Description>Corresponds to the adhoc checkbox in UI, but this should 
                            not be used for provisioning. OEM's should instead provision networks 
                            under ./Vendor/MSFT/Wi-Fi/Access-Point or ./Vendor/MSFT/Wi-Fi/Ad-Hoc to
                            specify the network type.
                        </Description>
                    </DFProperties>
                </Node>
                <Node>
                    <NodeName>KeyProvided</NodeName>
                    <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <bool />
                        </DFFormat>
                        <Occurrence>
                            <One />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <DFTitle>The key is automatically provided</DFTitle>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <Description></Description>
                    </DFProperties>
                </Node>
                <Node>
                    <NodeName>Use8021x</NodeName>
                    <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <bool />
                        </DFFormat>
                        <Occurrence>
                            <One />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <DFTitle>Use IEEE 802.1x network access control</DFTitle>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <Description></Description>
                    </DFProperties>
                </Node>
                <Node>
                    <NodeName>NetworkKey</NodeName>
                   <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <chr />
                        </DFFormat>
                        <Occurrence>
                            <One />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <DFTitle>Network key:</DFTitle>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <MSFT:MaxLength>64</MSFT:MaxLength>
                        <Description></Description>
                    </DFProperties>
                </Node>
            </Node>
        </Node>
        <Node>
            <NodeName>access-point</NodeName>
            <DFProperties>
                <AccessType>
                    <Get />
                </AccessType>
                <DFFormat>
                    <node />
                </DFFormat>
                <Occurrence>
                    <One />
                </Occurrence>
                <Scope>
                    <Permanent />
                </Scope>
                <Description>Wi-Fi network type (ad-hoc or access-point)</Description>
            </DFProperties>
            <Node>
                <NodeName></NodeName>
                <DFProperties>
                    <AccessType>
                        <Add />
                        <Get />
                        <Delete />
                    </AccessType>
                    <DFFormat>
                        <node />
                    </DFFormat>
                    <Occurrence>
                        <ZeroOrMore />
                    </Occurrence>
                    <Scope>
                        <Dynamic />    
                    </Scope>
                    <Description>To provision correctly, Add the network name you want, then Replace
                default values for EAPType, KeyIndex, Authentication, etc </Description>
                </DFProperties>
                <Node>
                    <NodeName>EAPType</NodeName>
                    <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <int />
                        </DFFormat>
                        <Occurrence>
                            <One />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <DFTitle>EAP type:</DFTitle>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <Description>The Wi-Fi network EAP type (13 = SmartCard or Certificate; 25 = Protected EAP)</Description>
                    </DFProperties>
                </Node>
                <Node>
                    <NodeName>KeyIndex</NodeName>
                    <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <int />
                        </DFFormat>
                        <Occurrence>
                            <One />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <DFTitle>Key index:</DFTitle>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <MSFT:MinValue>1</MSFT:MinValue>
                        <MSFT:MaxValue>4</MSFT:MaxValue>
                        <Description>The Wi-Fi network key index</Description>
                    </DFProperties>
                </Node>
                <Node>
                    <NodeName>Authentication</NodeName>
                    <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <int />
                        </DFFormat>
                        <Occurrence>
                            <One />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <DFTitle>Authentication:</DFTitle>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <Description>The Wi-Fi authentication method (0 = Open, 1 = Shared, 3 = WPA, 4 = WPA-PSK)</Description>
                    </DFProperties>
                </Node>
                <Node>
                    <NodeName>Encryption</NodeName>
                    <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <int />
                        </DFFormat>
                        <Occurrence>
                            <One />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <DFTitle>Data encryption:</DFTitle>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <Description>The Wi-Fi network data encryption standard (0 = WEP, 1 = None, 4 = TKIP)</Description>
                    </DFProperties>
                </Node>
                <Node>
                    <NodeName>DestId</NodeName>
                    <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <chr />
                        </DFFormat>
                        <Occurrence>
                            <One />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <DFTitle>Network type:</DFTitle>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <Description>Destination Network</Description>
                    </DFProperties>
                </Node>
                <Node>
                    <NodeName>AdHoc</NodeName>
                    <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <bool />
                        </DFFormat>
                        <Occurrence>
                            <One />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <DFTitle>This is a device to device (ad-hoc) connection</DFTitle>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <Description>Corresponds to the adhoc checkbox in UI, but this should 
                            not be used for provisioning. OEM's should instead provision networks 
                            under ./Vendor/MSFT/Wi-Fi/Access-Point or ./Vendor/MSFT/Wi-Fi/Ad-Hoc to
                            specify the network type.
                        </Description>
                    </DFProperties>
                </Node>
                <Node>
                    <NodeName>KeyProvided</NodeName>
                    <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <bool />
                        </DFFormat>
                        <Occurrence>
                            <One />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <DFTitle>The key is automatically provided</DFTitle>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <Description></Description>
                    </DFProperties>
                </Node>
                <Node>
                    <NodeName>Use8021x</NodeName>
                    <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <bool />
                        </DFFormat>
                        <Occurrence>
                            <One />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <DFTitle>Use IEEE 802.1x network access control</DFTitle>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <Description></Description>
                    </DFProperties>
                </Node>
                <Node>
                    <NodeName>NetworkKey</NodeName>
                   <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <chr />
                        </DFFormat>
                        <Occurrence>
                            <One />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <DFTitle>Network key:</DFTitle>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <MSFT:MaxLength>64</MSFT:MaxLength>
                        <Description></Description>
                    </DFProperties>
                </Node>
            </Node>
        </Node>
        <Node>
            <NodeName>Filter</NodeName>
            <DFProperties>
                <AccessType>
                    <Get />
                    <Replace />
                </AccessType>
                <DFFormat>
                    <int />
                </DFFormat>
                <Scope>
                    <Permanent />
                </Scope>
                <DFType>
                    <MIME>text/plain</MIME>
                </DFType>
                <MSFT:MinValue>0</MSFT:MinValue>
                <MSFT:MaxValue>2</MSFT:MaxValue>
                <Description>Specifies the networks that the device should access. Other networks are ignored. Possible values are “all”, “access-point”, and “ad-hoc”. Default value is “all”.</Description>
            </DFProperties>
        </Node>
    </Node>
</MgmtTree>

See Also

Reference

Wi-Fi Configuration Service Provider