From b5ab2996aae222ee94ce5a97d3a9d80529436a76 Mon Sep 17 00:00:00 2001
From: Vinay Pamnani <37223378+vinaypamnani-msft@users.noreply.github.com>
Date: Tue, 21 Feb 2023 13:03:03 -0500
Subject: [PATCH] eUICCs CSP
---
windows/client-management/mdm/euiccs-csp.md | 1101 +++++++++++++--
.../client-management/mdm/euiccs-ddf-file.md | 1216 +++++++++--------
2 files changed, 1623 insertions(+), 694 deletions(-)
diff --git a/windows/client-management/mdm/euiccs-csp.md b/windows/client-management/mdm/euiccs-csp.md
index 1d8c5255b7..59709ae2d8 100644
--- a/windows/client-management/mdm/euiccs-csp.md
+++ b/windows/client-management/mdm/euiccs-csp.md
@@ -1,194 +1,1047 @@
---
title: eUICCs CSP
-description: Learn how the eUICCs CSP is used to support eUICC enterprise use cases and enables the IT admin to manage (assign, reassign, remove) subscriptions to employees.
+description: Learn more about the eUICCs CSP.
+author: vinaypamnani-msft
+manager: aaroncz
ms.author: vinpa
-ms.topic: article
+ms.date: 02/21/2023
+ms.localizationpriority: medium
ms.prod: windows-client
ms.technology: itpro-manage
-author: vinaypamnani-msft
-ms.date: 03/02/2018
-ms.reviewer:
-manager: aaroncz
+ms.topic: reference
---
+
+
+
# eUICCs CSP
-The table below shows the applicability of Windows:
+
+
+The eUICCs configuration service provider is used to support eUICC enterprise use cases and enables the IT admin to manage (assign, reassign, remove) subscriptions to employees.
+
-|Edition|Windows 10|Windows 11|
-|--- |--- |--- |
-|Home|No|No|
-|Pro|Yes|Yes|
-|Windows SE|No|Yes|
-|Business|Yes|Yes|
-|Enterprise|Yes|Yes|
-|Education|Yes|Yes|
-
-The eUICCs configuration service provider is used to support eUICC enterprise use cases and enables the IT admin to manage (assign, reassign, remove) subscriptions to employees. This CSP was added in windows 10, version 1709.
-
-The following shows the eUICCs configuration service provider in tree format.
+
+The following example shows the eUICCs configuration service provider in tree format.
+```text
+./Device/Vendor/MSFT/eUICCs
+--- {eUICC}
+------ Actions
+--------- ResetToFactoryState
+--------- Status
+------ DownloadServers
+--------- {ServerName}
+------------ AutoEnable
+------------ DiscoveryState
+------------ IsDiscoveryServer
+------ Identifier
+------ IsActive
+------ Policies
+--------- LocalUIEnabled
+------ PPR1Allowed
+------ PPR1AlreadySet
+------ Profiles
+--------- {ICCID}
+------------ ErrorDetail
+------------ IsEnabled
+------------ MatchingID
+------------ PPR1Set
+------------ PPR2Set
+------------ ServerName
+------------ State
```
-./Device/Vendor/MSFT
-eUICCs
-----eUICC
---------Identifier
---------IsActive
---------PPR1Allowed
---------PPR1AlreadySet
---------DownloadServers
-------------ServerName
-----------------DiscoveryState
-----------------AutoEnable
-----------------IsDiscoveryServer
---------Profiles
-------------ICCID
-----------------ServerName
-----------------MatchingID
-----------------State
-----------------IsEnabled
-----------------PPR1Set
-----------------PPR2Set
-----------------ErrorDetail
---------Policies
-------------LocalUIEnabled
---------Actions
-------------ResetToFactoryState
-------------Status
+
+
+
+## {eUICC}
+
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
+
+
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}
```
+
-**./Vendor/MSFT/eUICCs**
-Root node for the eUICCs CSP.
+
+
+Represents information associated with an eUICC. There is one subtree for each known eUICC, created by the Local Profile Assistant (LPA) when the eUICC is first seen. The node name is the eUICC ID (EID). The node name "Default" represents the currently active eUICC.
+
-**_eUICC_**
-Interior node. Represents information associated with an eUICC. There's one subtree for each known eUICC, created by the Local Profile Assistant (LPA) when the eUICC is first seen. The node name is meaningful only to the LPA (which associates it with an eUICC ID (EID) in an implementation-specific manner, for example, this association could be an SHA-256 hash of the EID). The node name "Default" represents the currently active eUICC.
+
+
+
-Supported operation is Get.
+
+**Description framework properties**:
-**_eUICC_/Identifier**
-Required. Identifies an eUICC in an implementation-specific manner, for example, this identification could be an SHA-256 hash of the EID.
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+| Dynamic Node Naming | UniqueName: The eUICC ID (EID) associated with the device. |
+
-Supported operation is Get. Value type is string.
+
+
+
-**_eUICC_/IsActive**
-Required. Indicates whether this eUICC is physically present and active. Updated only by the LPA.
+
-Supported operation is Get. Value type is boolean.
+
+### {eUICC}/Actions
-**_eUICC_/PPR1Allowed**
-Profile Policy Rule 1 (PPR1) is required. Indicates whether the download of a profile with PPR1 is allowed. If the eUICC already has a profile (regardless of its origin and policy rules associated with it), the download of a profile with PPR1 isn't allowed.
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
+
-Supported operation is Get.
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/Actions
+```
+
-Value type is boolean.
+
+
+Actions that can be performed on the eUICC as a whole (when it is active).
+
-**_eUICC_/PPR1AlreadySet**
-Required. Indicates whether the eUICC already has a profile with PPR1.
+
+
+
-Supported operation is Get.
+
+**Description framework properties**:
-Value type is boolean.
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+
-**_eUICC_/DownloadServers**
-Interior node. Represents default SM-DP+ discovery requests.
+
+
+
-Supported operation is Get.
+
-**_eUICC_/DownloadServers/_ServerName_**
-Interior node. Optional. Node specifying the server name for a discovery operation. The node name is the fully qualified domain name of the SM-DP+ server that will be used for profile discovery. Creation of this subtree triggers a discovery request.
+
+#### {eUICC}/Actions/ResetToFactoryState
-Supported operations are Add, Get, and Delete.
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
+
-**_eUICC_/DownloadServers/_ServerName_/DiscoveryState**
-Required. Current state of the discovery operation for the parent ServerName (Requested = 1, Executing = 2, Completed = 3, Failed = 4). Queried by the CSP and only updated by the LPA.
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/Actions/ResetToFactoryState
+```
+
-Supported operation is Get.
+
+
+An EXECUTE on this node triggers the LPA to perform an eUICC Memory Reset.
+
-Value type is integer. Default value is 1.
+
+
+
-**_eUICC_/DownloadServers/_ServerName_/AutoEnable**
-Required. Indicates whether the discovered profile must be enabled automatically after install. This setting must be defined by the MDM when the ServerName subtree is created.
+
+**Description framework properties**:
-Supported operations are Add, Get, and Replace.
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Exec |
+
-Value type is bool.
+
+
+
-**_eUICC_/DownloadServers/_ServerName_/IsDiscoveryServer**
-Optional. Indicates whether the server is a discovery server. This setting must be defined by the MDM when the ServerName subtree is created.
+
-Supported operations are Add, Get, and Replace.
+
+#### {eUICC}/Actions/Status
-Value type is bool. Default value is false.
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
+
-**_eUICC_/Profiles**
-Interior node. Required. Represents all enterprise-owned profiles.
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/Actions/Status
+```
+
-Supported operation is Get.
+
+
+Status of most recent operation, as an HRESULT. S_OK indicates success, S_FALSE indicates operation is in progress, other values represent specific errors.
+
-**_eUICC_/Profiles/_ICCID_**
-Interior node. Optional. Node representing an enterprise-owned eUICC profile. The node name is the ICCID of the profile (which is a unique identifier). Creation of this subtree triggers an AddProfile request by the LPA (which installs the profile on the eUICC). Removal of this subtree triggers the LPA to delete the profile (if resident on the eUICC).
+
+
+
-Supported operations are Add, Get, and Delete.
+
+**Description framework properties**:
-**_eUICC_/Profiles/_ICCID_/ServerName**
-Required. Fully qualified domain name of the SM-DP+ that can download this profile. Must be set by the MDM when the ICCID subtree is created.
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Get |
+| Default Value | 0 |
+
-Supported operations are Add and Get.
+
+
+
-Value type is string.
+
-**_eUICC_/Profiles/_ICCID_/MatchingID**
-Required. Matching ID (activation code token) for profile download. Must be set by the MDM when the ICCID subtree is created.
+
+### {eUICC}/DownloadServers
-Supported operations are Add and Get.
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 11, version 21H2 [10.0.22000] and later |
+
-Value type is string.
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/DownloadServers
+```
+
-**_eUICC_/Profiles/_ICCID_/State**
-Required. Current state of the profile (Installing = 1, Installed = 2, Deleting = 3, Error = 4). Queried by the CSP and only updated by the LPA.
+
+
+Represents default SM-DP+ discovery requests.
+
-Supported operation is Get.
+
+
+
-Value type is integer. Default value is 1.
+
+**Description framework properties**:
-**_eUICC_/Profiles/_ICCID_/IsEnabled**
-Added in Windows 10, version 1803. Indicates whether this profile is enabled. Can be set by the MDM when the ICCID subtree is created to enable the profile once it’s successfully downloaded and installed on the device. Can also be queried and updated by the CSP.
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+
-Supported operations are Add, Get, and Replace.
+
+
+
-Value type is bool.
+
-**_eUICC_/Policies**
-Interior node. Required. Device policies associated with the eUICC as a whole (not per-profile).
+
+#### {eUICC}/DownloadServers/{ServerName}
-Supported operation is Get.
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 11, version 21H2 [10.0.22000] and later |
+
-**_eUICC_/Policies/LocalUIEnabled**
-Required. Determines whether the local user interface of the LUI is available (true if available, false otherwise). Initially populated by the LPA when the eUICC tree is created, can be queried and changed by the MDM server.
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/DownloadServers/{ServerName}
+```
+
-Supported operations are Get and Replace.
+
+
+Node representing the discovery operation for a server name. The node name is the fully qualified domain name of the SM-DP+ server that will be used for profile discovery. Creation of this subtree triggers a discovery request.
+
-Value type is boolean. Default value is true.
+
+
+
-**_eUICC_/Actions**
-Interior node. Required. Actions that can be performed on the eUICC as a whole (when it's active).
+
+**Description framework properties**:
-Supported operation is Get.
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Add, Delete, Get, Replace |
+| Dynamic Node Naming | UniqueName: ServerName used for the discovery operation. |
+
-**_eUICC_/Actions/ResetToFactoryState**
-Required. An EXECUTE on this node triggers the LPA to perform an eUICC Memory Reset.
+
+
+
-Supported operation is Execute.
+
-Value type is string.
+
+##### {eUICC}/DownloadServers/{ServerName}/AutoEnable
-**_eUICC_/Actions/Status**
-Required. Status of most recent operation, as an HRESULT. S_OK indicates success, S_FALSE indicates operation is in progress, other values represent specific errors.
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 11, version 21H2 [10.0.22000] and later |
+
-Supported value is Get.
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/DownloadServers/{ServerName}/AutoEnable
+```
+
-Value type is integer. Default is 0.
+
+
+Indicates whether the discovered profile must be enabled automatically after install. This must be set by the MDM when the ServerName subtree is created.
+
-## Related topics
+
+
+
-[Configuration service provider reference](index.yml)
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Add, Get, Replace |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| false | Disable. |
+| true | Enable. |
+
+
+
+
+
+
+
+
+
+##### {eUICC}/DownloadServers/{ServerName}/DiscoveryState
+
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 11, version 21H2 [10.0.22000] and later |
+
+
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/DownloadServers/{ServerName}/DiscoveryState
+```
+
+
+
+
+Current state of the discovery operation for the parent ServerName (Requested = 1, Executing = 2, Completed = 3, Failed = 4). Queried by the CSP and only updated by the LPA.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Get |
+| Default Value | 1 |
+
+
+
+
+
+
+
+
+
+##### {eUICC}/DownloadServers/{ServerName}/IsDiscoveryServer
+
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 11, version 22H2 [10.0.22621] and later |
+
+
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/DownloadServers/{ServerName}/IsDiscoveryServer
+```
+
+
+
+
+Indicates whether the server is a discovery server. Optional, default value is false.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Add, Get, Replace |
+| Default Value | false |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| false (Default) | Is Not Discovery Server. |
+| true | Is Discovery Server. |
+
+
+
+
+
+
+
+
+
+### {eUICC}/Identifier
+
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
+
+
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/Identifier
+```
+
+
+
+
+The EID.
+
+
+
+
+Identifies an eUICC in an implementation-specific manner, for example, this identification could be an SHA-256 hash of the EID.
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get |
+
+
+
+
+
+
+
+
+
+### {eUICC}/IsActive
+
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
+
+
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/IsActive
+```
+
+
+
+
+Indicates whether this eUICC is physically present and active. Updated only by the LPA.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Get |
+
+
+
+
+
+
+
+
+
+### {eUICC}/Policies
+
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
+
+
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/Policies
+```
+
+
+
+
+Device policies associated with the eUICC as a whole (not per-profile).
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+
+
+
+
+
+
+
+
+
+#### {eUICC}/Policies/LocalUIEnabled
+
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
+
+
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/Policies/LocalUIEnabled
+```
+
+
+
+
+Determines whether the local user interface of the LUI is available (true if available, false otherwise). Initially populated by the LPA when the eUICC tree is created, can be queried and changed by the MDM server.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Get, Replace |
+| Default Value | true |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| false | Disabled. |
+| true (Default) | Enabled. |
+
+
+
+
+
+
+
+
+
+### {eUICC}/PPR1Allowed
+
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
+
+
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/PPR1Allowed
+```
+
+
+
+
+Indicates whether the download of a profile with PPR1 is allowed. If the eUICC has already a profile (regardless of its origin and policy rules associated with it), then the download of a profile with PPR1 is not allowed.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Get |
+
+
+
+
+
+
+
+
+
+### {eUICC}/PPR1AlreadySet
+
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
+
+
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/PPR1AlreadySet
+```
+
+
+
+
+Indicates whether the eUICC has already a profile with PPR1.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Get |
+
+
+
+
+
+
+
+
+
+### {eUICC}/Profiles
+
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
+
+
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles
+```
+
+
+
+
+Represents all enterprise-owned profiles.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+
+
+
+
+
+
+
+
+
+#### {eUICC}/Profiles/{ICCID}
+
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
+
+
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles/{ICCID}
+```
+
+
+
+
+Node representing an enterprise-owned eUICC profile. The node name is the ICCID of the profile (which is a unique identifier). Creation of this subtree triggers an AddProfile request by the LPA (which installs the profile on the eUICC). Removal of this subtree triggers the LPA to delete the profile (if resident on the eUICC).
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Add, Delete, Get, Replace |
+| Dynamic Node Naming | UniqueName: ICCID of the profile. |
+
+
+
+
+
+
+
+
+
+##### {eUICC}/Profiles/{ICCID}/ErrorDetail
+
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
+
+
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles/{ICCID}/ErrorDetail
+```
+
+
+
+
+Detailed error if the profile download and install procedure failed (None = 0, CardGeneralFailure = 1, ConfirmationCodeMissing = 3, ForbiddenByPolicy = 5, InvalidMatchingId = 6, NoEligibleProfileForThisDevice = 7, NotEnoughSpaceOnCard = 8, ProfileEidMismatch = 10, ProfileNotAvailableForNewBinding = 11, ProfileNotReleasedByOperator = 12, RemoteServerGeneralFailure = 13, RemoteServerUnreachable = 14).
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Get |
+| Default Value | 0 |
+
+
+
+
+
+
+
+
+
+##### {eUICC}/Profiles/{ICCID}/IsEnabled
+
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1803 [10.0.17134] and later |
+
+
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles/{ICCID}/IsEnabled
+```
+
+
+
+
+Indicates whether this profile is enabled. Can be set by the MDM when the ICCID subtree is created. Can also be queried and updated by the CSP.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Add, Get, Replace |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| false | Disabled. |
+| true | Enabled. |
+
+
+
+
+
+
+
+
+
+##### {eUICC}/Profiles/{ICCID}/MatchingID
+
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
+
+
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles/{ICCID}/MatchingID
+```
+
+
+
+
+Matching ID (activation code token) for profile download. Must be set by the MDM when the ICCID subtree is created.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Add, Get, Replace |
+| Allowed Values | Regular Expression: `^([0-9a-fA-F]{5}-){3}[0-9a-fA-F]{5}$` |
+
+
+
+
+
+
+
+
+
+##### {eUICC}/Profiles/{ICCID}/PPR1Set
+
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
+
+
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles/{ICCID}/PPR1Set
+```
+
+
+
+
+This profile policy rule indicates whether disabling of this profile is not allowed (true if not allowed, false otherwise).
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Get |
+
+
+
+
+
+
+
+
+
+##### {eUICC}/Profiles/{ICCID}/PPR2Set
+
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
+
+
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles/{ICCID}/PPR2Set
+```
+
+
+
+
+This profile policy rule indicates whether deletion of this profile is not allowed (true if not allowed, false otherwise).
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Get |
+
+
+
+
+
+
+
+
+
+##### {eUICC}/Profiles/{ICCID}/ServerName
+
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
+
+
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles/{ICCID}/ServerName
+```
+
+
+
+
+Fully qualified domain name of the SM-DP+ that can download this profile. Must be set by the MDM when the ICCID subtree is created.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Add, Get, Replace |
+
+
+
+
+
+
+
+
+
+##### {eUICC}/Profiles/{ICCID}/State
+
+
+| Scope | Editions | Applicable OS |
+|:--|:--|:--|
+| :heavy_check_mark: Device
:x: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1709 [10.0.16299] and later |
+
+
+
+```Device
+./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles/{ICCID}/State
+```
+
+
+
+
+Current state of the profile (Installing = 1, Installed = 2, Deleting = 3, Error = 4). Queried by the CSP and only updated by the LPA.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Get |
+| Default Value | 1 |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Related articles
+
+[Configuration service provider reference](configuration-service-provider-reference.md)
diff --git a/windows/client-management/mdm/euiccs-ddf-file.md b/windows/client-management/mdm/euiccs-ddf-file.md
index a6de1b34ab..7e78256e0b 100644
--- a/windows/client-management/mdm/euiccs-ddf-file.md
+++ b/windows/client-management/mdm/euiccs-ddf-file.md
@@ -1,594 +1,670 @@
---
title: eUICCs DDF file
-description: Learn about the OMA DM device description framework (DDF) for the eUICCs configuration service provider (CSP).
-ms.reviewer:
+description: View the XML file containing the device description framework (DDF) for the eUICCs configuration service provider.
+author: vinaypamnani-msft
manager: aaroncz
ms.author: vinpa
-ms.topic: article
+ms.date: 02/21/2023
+ms.localizationpriority: medium
ms.prod: windows-client
ms.technology: itpro-manage
-author: vinaypamnani-msft
-ms.date: 03/02/2018
+ms.topic: reference
---
+
+
# eUICCs DDF file
-This topic shows the OMA DM device description framework (DDF) for the **eUICCs** configuration service provider. DDF files are used only with OMA DM provisioning XML.
-
-Looking for the DDF XML files? See [CSP DDF files download](configuration-service-provider-ddf.md).
-
-The XML below if for Windows 10, version 1803.
+The following XML file contains the device description framework (DDF) for the eUICCs configuration service provider.
```xml
-]>
+]>
- 1.2
+ 1.2
+
+
+
+ eUICCs
+ ./Device/Vendor/MSFT
+
+
+
+
+ Subtree for all embedded UICCs (eUICC)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.16299
+ 1.0
+ 0x4;0x1B;0x30;0x31;0x48;0x54;0x62;0x63;0x64;0x65;0x77;0x79;0x7A;0x7D;0x7E;0x81;0x82;0x8A;0x8B;0xA1;0xA2;0xA4;0xA5;0xAB;0xAC;0xAF;0xB4;0xBC;0xBF;0xCA;0xCB;0xCD;
+
+
- eUICCs
- ./Device/Vendor/MSFT
+
+
+
+
+
+
+ Represents information associated with an eUICC. There is one subtree for each known eUICC, created by the Local Profile Assistant (LPA) when the eUICC is first seen. The node name is the eUICC ID (EID). The node name "Default" represents the currently active eUICC.
+
+
+
+
+
+
+
+
+
+ eUICC
+
+
+
+
+ The eUICC ID (EID) associated with the device.
+
+
+
+ Identifier
-
-
-
- Subtree for all embedded UICCs (eUICC)
-
-
-
-
-
-
-
-
-
-
-
-
-
- com.microsoft/1.2/MDM/eUICCs
-
+
+
+
+ The EID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ IsActive
+
+
+
+
+ Indicates whether this eUICC is physically present and active. Updated only by the LPA.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PPR1Allowed
+
+
+
+
+ Indicates whether the download of a profile with PPR1 is allowed. If the eUICC has already a profile (regardless of its origin and policy rules associated with it), then the download of a profile with PPR1 is not allowed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PPR1AlreadySet
+
+
+
+
+ Indicates whether the eUICC has already a profile with PPR1.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ DownloadServers
+
+
+
+
+ Represents default SM-DP+ discovery requests.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.22000
+ 1.0
+
-
+
+
+
+
+
+
+
+
+
+ Node representing the discovery operation for a server name. The node name is the fully qualified domain name of the SM-DP+ server that will be used for profile discovery. Creation of this subtree triggers a discovery request.
+
+
+
+
+
+
+
+
+
+ ServerName
+
+
+
+
+ ServerName used for the discovery operation.
+
+
+
+ DiscoveryState
-
-
-
- Represents information associated with an eUICC. There is one subtree for each known eUICC, created by the Local Profile Assistant (LPA) when the eUICC is first seen. The node name is the eUICC ID (EID). The node name "Default" represents the currently active eUICC.
-
-
-
-
-
-
-
-
-
- eUICC
-
-
-
+
+
+
+ 1
+ Current state of the discovery operation for the parent ServerName (Requested = 1, Executing = 2, Completed = 3, Failed = 4). Queried by the CSP and only updated by the LPA.
+
+
+
+
+
+
+
+
+
+
+
+
-
- Identifier
-
-
-
-
- The EID.
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- IsActive
-
-
-
-
- Indicates whether this eUICC is physically present and active. Updated only by the LPA.
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- PPR1Allowed
-
-
-
-
- Indicates whether the download of a profile with PPR1 is allowed. If the eUICC already has a profile (regardless of its origin and policy rules associated with it), the download of a profile with PPR1 is not allowed.
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- PPR1AlreadySet
-
-
-
-
- Indicates whether the eUICC already has a profile with PPR1.
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- DownloadServers
-
-
-
-
- Represents default SM-DP+ discovery requests.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Node specifying the server name for a discovery operation. The node name is the fully qualified domain name of the SM-DP+ server that will be used for profile discovery. Creation of this subtree triggers a discovery request.
-
-
-
-
-
-
-
-
-
- ServerName
-
-
-
-
-
- DiscoveryState
-
-
-
-
- 1
- Current state of the discovery operation for the parent ServerName (Requested = 1, Executing = 2, Completed = 3, Failed = 4). Queried by the CSP and only updated by the LPA.
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- AutoEnable
-
-
-
-
-
-
- Indicates whether the discovered profile must be enabled automatically after install. This must be set by the MDM when the ServerName subtree is created.
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- IsDiscoveryServer
-
-
-
-
-
-
- false
- Indicates whether the server is a discovery server. Optional, default value is false.
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
-
-
- Profiles
-
-
-
-
- Represents all enterprise-owned profiles.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Node representing an enterprise-owned eUICC profile. The node name is the ICCID of the profile (which is a unique identifier). Creation of this subtree triggers an AddProfile request by the LPA (which installs the profile on the eUICC). Removal of this subtree triggers the LPA to delete the profile (if resident on the eUICC).
-
-
-
-
-
-
-
-
-
- ICCID
-
-
-
-
-
- ServerName
-
-
-
-
-
-
- Fully qualified domain name of the SM-DP+ that can download this profile. Must be set by the MDM when the ICCID subtree is created.
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- MatchingID
-
-
-
-
-
-
- Matching ID (activation code token) for profile download. Must be set by the MDM when the ICCID subtree is created.
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- State
-
-
-
-
- 1
- Current state of the profile (Installing = 1, Installed = 2, Deleting = 3, Error = 4). Queried by the CSP and only updated by the LPA.
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- IsEnabled
-
-
-
-
-
-
- Indicates whether this profile is enabled. Can be set by the MDM when the ICCID subtree is created. Can also be queried and updated by the CSP.
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- PPR1Set
-
-
-
-
- This profile policy rule indicates whether disabling of this profile is not allowed (true if not allowed, false otherwise).
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- PPR2Set
-
-
-
-
- This profile policy rule indicates whether deletion of this profile is not allowed (true if not allowed, false otherwise).
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- ErrorDetail
-
-
-
-
- 0
- Detailed error if the profile download and install procedure failed (None = 0, CardGeneralFailure = 1, ConfirmationCodeMissing = 3, ForbiddenByPolicy = 5, InvalidMatchingId = 6, NoEligibleProfileForThisDevice = 7, NotEnoughSpaceOnCard = 8, ProfileEidMismatch = 10, ProfileNotAvailableForNewBinding = 11, ProfileNotReleasedByOperator = 12, RemoteServerGeneralFailure = 13, RemoteServerUnreachable = 14).
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
-
-
- Policies
-
-
-
-
- Device policies associated with the eUICC as a whole (not per-profile).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LocalUIEnabled
-
-
-
-
-
- true
- Determines whether the local user interface of the LUI is available (true if available, false otherwise). Initially populated by the LPA when the eUICC tree is created, can be queried and changed by the MDM server.
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
-
- Actions
-
-
-
-
- Actions that can be performed on the eUICC as a whole (when it is active).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ResetToFactoryState
-
-
-
-
- An EXECUTE on this node triggers the LPA to perform an eUICC Memory Reset.
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- Status
-
-
-
-
- 0
- Status of most recent operation, as an HRESULT. S_OK indicates success, S_FALSE indicates operation is in progress, other values represent specific errors.
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
+
+
+ AutoEnable
+
+
+
+
+
+
+ Indicates whether the discovered profile must be enabled automatically after install. This must be set by the MDM when the ServerName subtree is created.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ false
+ Disable
+
+
+ true
+ Enable
+
+
+
+
+
+ IsDiscoveryServer
+
+
+
+
+
+
+ false
+ Indicates whether the server is a discovery server. Optional, default value is false.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.22621
+ 1.0
+
+
+
+ false
+ Is Not Discovery Server
+
+
+ true
+ Is Discovery Server
+
+
+
+
+
+
+ Profiles
+
+
+
+
+ Represents all enterprise-owned profiles.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Node representing an enterprise-owned eUICC profile. The node name is the ICCID of the profile (which is a unique identifier). Creation of this subtree triggers an AddProfile request by the LPA (which installs the profile on the eUICC). Removal of this subtree triggers the LPA to delete the profile (if resident on the eUICC).
+
+
+
+
+
+
+
+
+
+ ICCID
+
+
+
+
+ ICCID of the profile.
+
+
+
+ ServerName
+
+
+
+
+
+
+ Fully qualified domain name of the SM-DP+ that can download this profile. Must be set by the MDM when the ICCID subtree is created.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MatchingID
+
+
+
+
+
+
+ Matching ID (activation code token) for profile download. Must be set by the MDM when the ICCID subtree is created.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^([0-9a-fA-F]{5}-){3}[0-9a-fA-F]{5}$
+
+
+
+
+ State
+
+
+
+
+ 1
+ Current state of the profile (Installing = 1, Installed = 2, Deleting = 3, Error = 4). Queried by the CSP and only updated by the LPA.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ IsEnabled
+
+
+
+
+
+
+ Indicates whether this profile is enabled. Can be set by the MDM when the ICCID subtree is created. Can also be queried and updated by the CSP.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.17134
+ 1.0
+
+
+
+ false
+ Disabled
+
+
+ true
+ Enabled
+
+
+
+
+
+ PPR1Set
+
+
+
+
+ This profile policy rule indicates whether disabling of this profile is not allowed (true if not allowed, false otherwise).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PPR2Set
+
+
+
+
+ This profile policy rule indicates whether deletion of this profile is not allowed (true if not allowed, false otherwise).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ErrorDetail
+
+
+
+
+ 0
+ Detailed error if the profile download and install procedure failed (None = 0, CardGeneralFailure = 1, ConfirmationCodeMissing = 3, ForbiddenByPolicy = 5, InvalidMatchingId = 6, NoEligibleProfileForThisDevice = 7, NotEnoughSpaceOnCard = 8, ProfileEidMismatch = 10, ProfileNotAvailableForNewBinding = 11, ProfileNotReleasedByOperator = 12, RemoteServerGeneralFailure = 13, RemoteServerUnreachable = 14).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Policies
+
+
+
+
+ Device policies associated with the eUICC as a whole (not per-profile).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LocalUIEnabled
+
+
+
+
+
+ true
+ Determines whether the local user interface of the LUI is available (true if available, false otherwise). Initially populated by the LPA when the eUICC tree is created, can be queried and changed by the MDM server.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ false
+ Disabled
+
+
+ true
+ Enabled
+
+
+
+
+
+
+ Actions
+
+
+
+
+ Actions that can be performed on the eUICC as a whole (when it is active).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ResetToFactoryState
+
+
+
+
+ An EXECUTE on this node triggers the LPA to perform an eUICC Memory Reset.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Status
+
+
+
+
+ 0
+ Status of most recent operation, as an HRESULT. S_OK indicates success, S_FALSE indicates operation is in progress, other values represent specific errors.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
```
+
+## Related articles
+
+[eUICCs configuration service provider reference](euiccs-csp.md)