mirror of https://github.com/MicrosoftDocs/windows-itpro-docs.git synced 2025-05-12 05:17:22 +00:00

Vinay Pamnani 18087e39de Add IoT applicability

2023-08-11 10:31:52 -04:00

44 KiB

Raw Blame History

title, description, author, manager, ms.author, ms.date, ms.localizationpriority, ms.prod, ms.technology, ms.topic

title	description	author	manager	ms.author	ms.date	ms.localizationpriority	ms.prod	ms.technology	ms.topic
eUICCs CSP	Learn more about the eUICCs CSP.	vinaypamnani-msft	aaroncz	vinpa	08/10/2023	medium	windows-client	itpro-manage	reference

eUICCs CSP

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.

The following list shows the eUICCs configuration service provider nodes:

./Device/Vendor/MSFT/eUICCs
- {eUICC}
  - Actions
    - ResetToFactoryState
    - Status
  - DownloadServers
    - {ServerName}
  - Identifier
  - IsActive
  - Policies
    - LocalUIEnabled
  - PPR1Allowed
  - PPR1AlreadySet
  - Profiles
    - {ICCID}
      - ErrorDetail
      - IsEnabled
      - MatchingID
      - PPR1Set
      - PPR2Set
      - ServerName
      - State

{eUICC}

Scope	Editions	Applicable OS
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1709 [10.0.16299] and later

./Device/Vendor/MSFT/eUICCs/{eUICC}

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.

Description framework properties:

Property name	Property value
Format	`node`
Access Type	Get
Dynamic Node Naming	UniqueName: The eUICC ID (EID) associated with the device.

{eUICC}/Actions

Scope	Editions	Applicable OS
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1709 [10.0.16299] and later

./Device/Vendor/MSFT/eUICCs/{eUICC}/Actions

Actions that can be performed on the eUICC as a whole (when it's active).

Description framework properties:

Property name	Property value
Format	`node`
Access Type	Get

{eUICC}/Actions/ResetToFactoryState

Scope	Editions	Applicable OS
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1709 [10.0.16299] and later

./Device/Vendor/MSFT/eUICCs/{eUICC}/Actions/ResetToFactoryState

An EXECUTE on this node triggers the LPA to perform an eUICC Memory Reset.

Description framework properties:

Property name	Property value
Format	`chr` (string)
Access Type	Exec

{eUICC}/Actions/Status

Scope	Editions	Applicable OS
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1709 [10.0.16299] and later

./Device/Vendor/MSFT/eUICCs/{eUICC}/Actions/Status

Status of most recent operation, as an HRESULT. S_OK indicates success, S_FALSE indicates operation is in progress, other values represent specific errors.

Description framework properties:

Property name	Property value
Format	`int`
Access Type	Get
Default Value	0

{eUICC}/DownloadServers

Scope	Editions	Applicable OS
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 11, version 21H2 [10.0.22000] and later

./Device/Vendor/MSFT/eUICCs/{eUICC}/DownloadServers

Represents default SM-DP+ discovery requests.

Description framework properties:

Property name	Property value
Format	`node`
Access Type	Get

{eUICC}/DownloadServers/{ServerName}

Scope	Editions	Applicable OS
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 11, version 21H2 [10.0.22000] and later

./Device/Vendor/MSFT/eUICCs/{eUICC}/DownloadServers/{ServerName}

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.

Description framework properties:

Property name	Property value
Format	`node`
Access Type	Add, Delete, Get, Replace
Dynamic Node Naming	UniqueName: ServerName used for the discovery operation.

{eUICC}/DownloadServers/{ServerName}/AutoEnable

Scope	Editions	Applicable OS
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 11, version 21H2 [10.0.22000] and later

./Device/Vendor/MSFT/eUICCs/{eUICC}/DownloadServers/{ServerName}/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.

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
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 11, version 21H2 [10.0.22000] and later

./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
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 11, version 22H2 [10.0.22621] and later

./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
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1709 [10.0.16299] and later

./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
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1709 [10.0.16299] and later

./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
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1709 [10.0.16299] and later

./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
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1709 [10.0.16299] and later

./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
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1709 [10.0.16299] and later

./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 isn't allowed.

Description framework properties:

Property name	Property value
Format	`bool`
Access Type	Get

{eUICC}/PPR1AlreadySet

Scope	Editions	Applicable OS
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1709 [10.0.16299] and later

./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
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1709 [10.0.16299] and later

./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
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1709 [10.0.16299] and later

./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
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1709 [10.0.16299] and later

./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
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1803 [10.0.17134] and later

./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
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1709 [10.0.16299] and later

./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
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1709 [10.0.16299] and later

./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles/{ICCID}/PPR1Set

This profile policy rule indicates whether disabling of this profile isn't 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
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1709 [10.0.16299] and later

./Device/Vendor/MSFT/eUICCs/{eUICC}/Profiles/{ICCID}/PPR2Set

This profile policy rule indicates whether deletion of this profile isn't 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
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1709 [10.0.16299] and later

./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
✅ Device ❌ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1709 [10.0.16299] and later

./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

Configuration service provider reference

44 KiB Raw Blame History

eUICCs CSP

{eUICC}

{eUICC}/Actions

{eUICC}/Actions/ResetToFactoryState

{eUICC}/Actions/Status

{eUICC}/DownloadServers

{eUICC}/DownloadServers/{ServerName}

{eUICC}/DownloadServers/{ServerName}/AutoEnable

{eUICC}/DownloadServers/{ServerName}/DiscoveryState

{eUICC}/DownloadServers/{ServerName}/IsDiscoveryServer

{eUICC}/Identifier

{eUICC}/IsActive

{eUICC}/Policies

{eUICC}/Policies/LocalUIEnabled

{eUICC}/PPR1Allowed

{eUICC}/PPR1AlreadySet

{eUICC}/Profiles

{eUICC}/Profiles/{ICCID}

{eUICC}/Profiles/{ICCID}/ErrorDetail

{eUICC}/Profiles/{ICCID}/IsEnabled

{eUICC}/Profiles/{ICCID}/MatchingID

{eUICC}/Profiles/{ICCID}/PPR1Set

{eUICC}/Profiles/{ICCID}/PPR2Set

{eUICC}/Profiles/{ICCID}/ServerName

{eUICC}/Profiles/{ICCID}/State

Related articles

44 KiB

Raw Blame History