From afc9df8126d8ee3848f639dad70cfbd9cc923c9d Mon Sep 17 00:00:00 2001
From: Vinay Pamnani <37223378+vinaypamnani-msft@users.noreply.github.com>
Date: Tue, 21 Feb 2023 12:15:06 -0500
Subject: [PATCH] SharedPC CSP
---
windows/client-management/mdm/sharedpc-csp.md | 941 ++++++++++++--
.../mdm/sharedpc-ddf-file.md | 1116 ++++++++++-------
2 files changed, 1475 insertions(+), 582 deletions(-)
diff --git a/windows/client-management/mdm/sharedpc-csp.md b/windows/client-management/mdm/sharedpc-csp.md
index 9ec9fb7703..42d1d31c8c 100644
--- a/windows/client-management/mdm/sharedpc-csp.md
+++ b/windows/client-management/mdm/sharedpc-csp.md
@@ -1,194 +1,877 @@
---
title: SharedPC CSP
-description: Learn how the SharedPC configuration service provider is used to configure settings for Shared PC usage.
-ms.reviewer:
+description: Learn more about the SharedPC 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: 09/23/2022
+ms.topic: reference
---
+
+
+
# SharedPC CSP
-The table below shows the applicability of Windows:
-
-|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 SharedPC configuration service provider is used to configure settings for Shared PC usage.
+
-The following example shows the SharedPC configuration service provider management objects in tree format as used by Open Mobile Alliance Device Management (OMA DM), OMA Client Provisioning, and Enterprise DM.
+
+The following example shows the SharedPC configuration service provider in tree format.
+
+```text
+./Vendor/MSFT/SharedPC
+--- AccountModel
+--- DeletionPolicy
+--- DiskLevelCaching
+--- DiskLevelDeletion
+--- EnableAccountManager
+--- EnableSharedPCMode
+--- EnableSharedPCModeWithOneDriveSync
+--- EnableWindowsInsiderPreviewFlighting
+--- InactiveThreshold
+--- KioskModeAUMID
+--- KioskModeUserTileDisplayText
+--- MaintenanceStartTime
+--- MaxPageFileSizeMB
+--- RestrictLocalStorage
+--- SetEduPolicies
+--- SetPowerPolicies
+--- SignInOnResume
+--- SleepTimeout
```
-./Vendor/MSFT
-SharedPC
-----EnableSharedPCMode
-----EnableSharedPCModeWithOneDriveSync
-----SetEduPolicies
-----SetPowerPolicies
-----MaintenanceStartTime
-----SignInOnResume
-----SleepTimeout
-----EnableAccountManager
-----AccountModel
-----DeletionPolicy
-----DiskLevelDeletion
-----DiskLevelCaching
-----RestrictLocalStorage
-----KioskModeAUMID
-----KioskModeUserTileDisplayText
-----InactiveThreshold
-----MaxPageFileSizeMB
+
+
+
+## AccountModel
+
+
+| 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 1607 [10.0.14393] and later |
+
+
+
+```Device
+./Vendor/MSFT/SharedPC/AccountModel
```
-**./Vendor/MSFT/SharedPC**
-The root node for the SharedPC configuration service provider.
+
-The supported operation is Get.
+
+
+Configures which type of accounts are allowed to use the PC. Allowed values: 0 (only guest), 1 (domain-joined only), 2 (domain-joined and guest). If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
-**EnableSharedPCMode**
-A boolean value that specifies whether Shared PC mode is enabled.
+
+
+
-The supported operations are Add, Get, Replace, and Delete.
+
+**Description framework properties**:
-Setting this value to True triggers the action to configure a device to Shared PC mode.
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Add, Delete, Get, Replace |
+| Default Value | 0 |
+
-The default value is Not Configured and SharedPC mode is not enabled.
+
+**Allowed values**:
-**EnableSharedPCModeWithOneDriveSync**
-Setting this node to true triggers the action to configure a device to Shared PC mode with OneDrive sync turned on.
+| Value | Description |
+|:--|:--|
+| 0 (Default) | Only guest accounts are allowed. |
+| 1 | Only domain-joined accounts are allowed. |
+| 2 | Domain-joined and guest accounts are allowed. |
+
-The supported operations are Add, Get, Replace, and Delete.
+
+
+
-The default value is false.
+
-**SetEduPolicies**
+
+## DeletionPolicy
+
+
+| 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 1607 [10.0.14393] and later |
+
+
+
+```Device
+./Vendor/MSFT/SharedPC/DeletionPolicy
+```
+
+
+
+
+Configures when accounts will be deleted. Allowed values: 0 (delete immediately), 1 (delete at disk space threshold), 2 (Delete at disk space threshold and inactive threshold). If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Add, Delete, Get, Replace |
+| Default Value | 1 |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| 0 | Delete immediately. |
+| 1 (Default) | Delete at disk space threshold. |
+| 2 | Delete at disk space threshold and inactive threshold. |
+
+
+
+
+
+
+
+
+
+## DiskLevelCaching
+
+
+| 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 1607 [10.0.14393] and later |
+
+
+
+```Device
+./Vendor/MSFT/SharedPC/DiskLevelCaching
+```
+
+
+
+
+Stop deleting accounts when available disk space reaches this threshold, given as percent of total disk capacity. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Add, Delete, Get, Replace |
+| Allowed Values | Range: `[0-100]` |
+| Default Value | 50 |
+
+
+
+
+
+
+
+
+
+## DiskLevelDeletion
+
+
+| 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 1607 [10.0.14393] and later |
+
+
+
+```Device
+./Vendor/MSFT/SharedPC/DiskLevelDeletion
+```
+
+
+
+
+Accounts will start being deleted when available disk space falls below this threshold, given as percent of total disk capacity. Accounts that have been inactive the longest will be deleted first. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+For example, if the DiskLevelCaching is set to 50 and the DiskLevelDeletion is set to 25 (both default values). Accounts will be cached while the free disk space is above 25%. When the free disk space is less than 25% (the deletion number) during a daily maintenance period, accounts will be deleted (oldest last used first) when the system is idle until the free disk space is above 50% (the caching number). Accounts will be deleted immediately on signing out from an account if free space is under half of the deletion threshold and disk space is low, regardless of whether the PC is actively in use or not.
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Add, Delete, Get, Replace |
+| Allowed Values | Range: `[0-100]` |
+| Default Value | 25 |
+
+
+
+
+
+
+
+
+
+## EnableAccountManager
+
+
+| 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 1607 [10.0.14393] and later |
+
+
+
+```Device
+./Vendor/MSFT/SharedPC/EnableAccountManager
+```
+
+
+
+
+Enable the account manager for shared PC mode. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Add, Delete, Get, Replace |
+| Default Value | false |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| false (Default) | False. |
+| true | True. |
+
+
+
+
+
+
+
+
+
+## EnableSharedPCMode
+
+
+| 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 1607 [10.0.14393] and later |
+
+
+
+```Device
+./Vendor/MSFT/SharedPC/EnableSharedPCMode
+```
+
+
+
+
+Setting this node to "true" triggers the action to configure a device to Shared PC mode.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Add, Delete, Get, Replace |
+| Default Value | false |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| false (Default) | Not configured. |
+| true | Enabled. |
+
+
+
+
+
+
+
+
+
+## EnableSharedPCModeWithOneDriveSync
+
+
+| 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
+./Vendor/MSFT/SharedPC/EnableSharedPCModeWithOneDriveSync
+```
+
+
+
+
+Setting this node to "1" triggers the action to configure a device to Shared PC mode with OneDrive sync turned on.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Add, Delete, Get, Replace |
+| Default Value | false |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| false (Default) | Not configured. |
+| true | Enabled. |
+
+
+
+
+
+
+
+
+
+## EnableWindowsInsiderPreviewFlighting
+
+
+| 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
+./Vendor/MSFT/SharedPC/EnableWindowsInsiderPreviewFlighting
+```
+
+
+
+
+Setting this node to "1" enables Windows Insider Preview flighting and the ability to receive insider preview builds.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Add, Delete, Get, Replace |
+| Default Value | false |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| false (Default) | Not configured. |
+| true | WIP builds are Enabled. |
+
+
+
+
+
+
+
+
+
+## InactiveThreshold
+
+
+| 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 1703 [10.0.15063] and later |
+
+
+
+```Device
+./Vendor/MSFT/SharedPC/InactiveThreshold
+```
+
+
+
+
+Accounts will start being deleted when they have not been logged on during the specified period, given as number of days.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Add, Delete, Get, Replace |
+| Allowed Values | Range: `[0-4294967295]` |
+| Default Value | 30 |
+
+
+
+
+
+
+
+
+
+## KioskModeAUMID
+
+
+| 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 1703 [10.0.15063] and later |
+
+
+
+```Device
+./Vendor/MSFT/SharedPC/KioskModeAUMID
+```
+
+
+
+
+Specifies the AUMID of the app to use with assigned access. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Add, Delete, Get, Replace |
+
+
+
+
+
+
+
+
+
+## KioskModeUserTileDisplayText
+
+
+| 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 1703 [10.0.15063] and later |
+
+
+
+```Device
+./Vendor/MSFT/SharedPC/KioskModeUserTileDisplayText
+```
+
+
+
+
+Specifies the display text for the account shown on the sign-in screen which launches the app specified by KioskModeAUMID. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Add, Delete, Get, Replace |
+
+
+
+
+
+
+
+
+
+## MaintenanceStartTime
+
+
+| 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 1607 [10.0.14393] and later |
+
+
+
+```Device
+./Vendor/MSFT/SharedPC/MaintenanceStartTime
+```
+
+
+
+
+Daily start time of maintenance hour. Given in minutes from midnight. Default is 0 (12am). If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Add, Delete, Get, Replace |
+| Allowed Values | Range: `[0-1440]` |
+| Default Value | 0 |
+
+
+
+
+
+
+
+
+
+## MaxPageFileSizeMB
+
+
+| 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 1703 [10.0.15063] and later |
+
+
+
+```Device
+./Vendor/MSFT/SharedPC/MaxPageFileSizeMB
+```
+
+
+
+
+Maximum size of the paging file in MB. Applies only to systems with less than 32 GB storage and at least 3 GB of RAM. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Add, Delete, Get, Replace |
+| Allowed Values | Range: `[0-32768]` |
+| Default Value | 1024 |
+
+
+
+
+
+
+
+
+
+## RestrictLocalStorage
+
+
+| 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 1703 [10.0.15063] and later |
+
+
+
+```Device
+./Vendor/MSFT/SharedPC/RestrictLocalStorage
+```
+
+
+
+
+Restricts the user from using local storage. This node is optional. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Add, Delete, Get, Replace |
+| Default Value | false |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| false (Default) | False. |
+| true | True. |
+
+
+
+
+
+
+
+
+
+## SetEduPolicies
+
+
+| 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 1607 [10.0.14393] and later |
+
+
+
+```Device
+./Vendor/MSFT/SharedPC/SetEduPolicies
+```
+
+
+
+
+Set a list of EDU policies.
+
+
+
+
A boolean value that specifies whether the policies for education environment are enabled. Setting this value to true triggers the action to configure a device as education environment.
+
-The supported operations are Add, Get, Replace, and Delete.
+
+**Description framework properties**:
-The default value is Not Configured.
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Add, Delete, Get, Replace |
+| Default Value | false |
+
-**SetPowerPolicies**
-A boolean value that specifies that the power policies should be set when configuring SharedPC mode.
+
+**Allowed values**:
-The supported operations are Add, Get, Replace, and Delete.
+| Value | Description |
+|:--|:--|
+| false (Default) | Not configured. |
+| true | Enabled. |
+
-The default value is Not Configured and the effective power settings are determined by the OS's default power settings. Its value in the SharedPC provisioning package is True.
+
+
+
-**MaintenanceStartTime**
-An integer value that specifies the daily start time of maintenance hour. Given in minutes from midnight. The range is 0-1440.
+
-The supported operations are Add, Get, Replace, and Delete.
+
+## SetPowerPolicies
-The default value is Not Configured and its value in the SharedPC provisioning package is 0 (12 AM).
+
+| 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 1607 [10.0.14393] and later |
+
-**SignInOnResume**
-A boolean value that, when set to True, requires sign in whenever the device wakes up from sleep mode.
+
+```Device
+./Vendor/MSFT/SharedPC/SetPowerPolicies
+```
+
-The supported operations are Add, Get, Replace, and Delete.
+
+
+Set a list of power policies. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
-The default value is Not Configured and its value in the SharedPC provisioning package is True.
+
+
+The default value is Not Configured and the effective power settings are determined by the OS's default power settings.
+
-**SleepTimeout**
-The amount of time in seconds before the PC sleeps. 0 means the PC never sleeps. Default is 5 minutes.
+
+**Description framework properties**:
-The supported operations are Add, Get, Replace, and Delete.
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Add, Delete, Get, Replace |
+| Default Value | false |
+
-The default value is Not Configured, and effective behavior is determined by the OS's default settings. Its value in SharedPC provisioning package is 300.
+
+**Allowed values**:
-**EnableAccountManager**
-A boolean that enables the account manager for shared PC mode.
+| Value | Description |
+|:--|:--|
+| false (Default) | Not configured. |
+| true | Enabled. |
+
-The supported operations are Add, Get, Replace, and Delete.
+
+
+
-The default value is Not Configured and its value in the SharedPC provisioning package is True.
+
-**AccountModel**
-Configures which type of accounts are allowed to use the PC.
+
+## SignInOnResume
-The supported operations are Add, Get, Replace, 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 1607 [10.0.14393] and later |
+
-The following list shows the supported values:
+
+```Device
+./Vendor/MSFT/SharedPC/SignInOnResume
+```
+
-- 0 (default) - Only guest accounts are allowed.
-- 1 - Only domain-joined accounts are enabled.
-- 2 - Domain-joined and guest accounts are allowed.
+
+
+Require signing in on waking up from sleep. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
-Its value in the SharedPC provisioning package is 1 or 2.
+
+
+
-**DeletionPolicy**
-Configures when accounts are deleted.
+
+**Description framework properties**:
-The supported operations are Add, Get, Replace, and Delete.
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Add, Delete, Get, Replace |
+| Default Value | false |
+
-This is the list of supported values:
+
+**Allowed values**:
-- 0 - Delete immediately.
-- 1 - Delete at disk space threshold.
-- 2 - Delete at disk space threshold and inactive threshold.
+| Value | Description |
+|:--|:--|
+| false (Default) | False. |
+| true | True. |
+
-The default value is Not Configured. Its value in the SharedPC provisioning package is 1 or 2.
+
+
+
-**DiskLevelDeletion**
-Sets the percentage of disk space remaining on a PC before cached accounts will be deleted to free disk space. Accounts that have been inactive the longest will be deleted first.
+
-The default value is Not Configured. Its default value in the SharedPC provisioning package is 25.
+
+## SleepTimeout
-For example, if the **DiskLevelCaching** number is set to 50 and the **DiskLevelDeletion** number is set to 25 (both default values). Accounts will be cached while the free disk space is above 25%. When the free disk space is less than 25% (the deletion number) during a daily maintenance period, accounts will be deleted (oldest last used first) when the system is idle until the free disk space is above 50% (the caching number). Accounts will be deleted immediately on signing out from an account if free space is under half of the deletion threshold and disk space is low, regardless of whether the PC is actively in use or not.
+
+| 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 1607 [10.0.14393] and later |
+
-The supported operations are Add, Get, Replace, and Delete.
+
+```Device
+./Vendor/MSFT/SharedPC/SleepTimeout
+```
+
-**DiskLevelCaching**
-Sets the percentage of available disk space a PC should have before it stops deleting cached accounts.
+
+
+The amount of time before the PC sleeps, giving in seconds. 0 means the PC never sleeps. Default is 5 minutes. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
-The default value is Not Configured. The default value in the SharedPC provisioning package is 25.
+
+
+
-For example, if the **DiskLevelCaching** number is set to 50 and the **DiskLevelDeletion** number is set to 25 (both default values). Accounts will be cached while the free disk space is above 25%. When the free disk space is less than 25% (the deletion number) during a maintenance period, accounts will be deleted (oldest last used first) until the free disk space is above 50% (the caching number). Accounts will be deleted immediately on signing out from an account if free space is under the deletion threshold and disk space is low, regardless whether the PC is actively in use or not.
+
+**Description framework properties**:
-The supported operations are Add, Get, Replace, and Delete.
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Add, Delete, Get, Replace |
+| Allowed Values | Range: `[0-4294967295]` |
+| Default Value | 300 |
+
-**RestrictLocalStorage**
-Restricts the user from using local storage.
+
+
+
-The default value is Not Configured. Value type is bool. Supported operations are Add, Get, Replace, and Delete. Default in SharedPC provisioning package is False.
+
-**KioskModeAUMID**
-Specifies the AUMID of the app to use with assigned access.
+
+
+
-- Value type is string.
-- Supported operations are Add, Get, Replace, and Delete.
+
-**KioskModeUserTileDisplayText**
-Specifies the display text for the account shown on the sign-in screen that launches the app specified by KioskModeAUMID.
+## Related articles
-Value type is string. Supported operations are Add, Get, Replace, and Delete.
-
-**InactiveThreshold**
-Accounts will start being deleted when they haven't been logged on during the specified period, given as number of days.
-
-- The default value is Not Configured.
-- Value type is integer.
-- Supported operations are Add, Get, Replace, and Delete.
-
-The default in the SharedPC provisioning package is 30.
-
-**MaxPageFileSizeMB**
-Maximum size of the paging file in MB. Applies only to systems with less than 32-GB storage and at least 3 GB of RAM.
-
-- Default value is Not Configured.
-- Value type is integer.
-- Supported operations are Add, Get, Replace, and Delete.
-
-The default in the SharedPC provisioning package is 1024.
-
-## Related topics
-
-[Configuration service provider reference](index.yml)
+[Configuration service provider reference](configuration-service-provider-reference.md)
diff --git a/windows/client-management/mdm/sharedpc-ddf-file.md b/windows/client-management/mdm/sharedpc-ddf-file.md
index 764d14a202..0fc3249c8c 100644
--- a/windows/client-management/mdm/sharedpc-ddf-file.md
+++ b/windows/client-management/mdm/sharedpc-ddf-file.md
@@ -1,473 +1,683 @@
---
title: SharedPC DDF file
-description: Learn how the OMA DM device description framework (DDF) for the SharedPC configuration service provider (CSP).
-ms.reviewer:
+description: View the XML file containing the device description framework (DDF) for the SharedPC 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: 12/05/2017
+ms.topic: reference
---
+
+
# SharedPC DDF file
-This topic shows the OMA DM device description framework (DDF) for the **SharedPC** 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 is the DDF for Windows 10, version 1703.
+The following XML file contains the device description framework (DDF) for the SharedPC configuration service provider.
```xml
-]>
+]>
- 1.2
+ 1.2
+
+
+
+ SharedPC
+ ./Vendor/MSFT
+
+
+
+
+ The root node for the SharedPC configuration service provider.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.14393
+ 1.0
+ 0x4;0x1B;0x30;0x31;0x48;0x54;0x77;0x79;0x7A;0x7D;0x7E;0x81;0x82;0x8A;0x8B;0xA1;0xA2;0xA4;0xA5;0xAB;0xAC;0xAF;0xB4;0xBC;0xBF;0xCA;0xCB;0xCD;
+
+
- SharedPC
- ./Vendor/MSFT
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- com.microsoft/1.1/MDM/SharedPC
-
-
-
- EnableSharedPCMode
-
-
-
-
-
- false
- Setting this node to "true" triggers the action to configure a device to Shared PC mode.
-
-
-
-
-
-
-
-
-
- Enable shared PC mode
-
- text/plain
-
-
-
-
- EnableSharedPCModeWithOneDriveSync
-
-
-
-
-
-
-
- false
- Setting this node to "1" triggers the action to configure a device to Shared PC mode with OneDrive sync turned on
-
-
-
-
-
-
-
-
-
- Enable Shared PC mode with OneDrive sync
-
-
-
-
-
-
- SetEduPolicies
-
-
-
-
-
- false
- Set a list of EDU policies.
-
-
-
-
-
-
-
-
-
- Set EDU policies
-
- text/plain
-
-
-
-
- SetPowerPolicies
-
-
-
-
-
- true
- Specify that the power policies should be set when configuring SharedPC mode. This node is optional.
-
-
-
-
-
-
-
-
-
- Set power policies
-
- text/plain
-
-
-
-
- MaintenanceStartTime
-
-
-
-
-
- 0
- Daily start time of maintenance hour. Given in minutes from midnight. Default is 0 (12am). This node is optional.
-
-
-
-
-
-
-
-
-
- Maintenance start time
-
- text/plain
-
-
-
-
- SignInOnResume
-
-
-
-
-
- true
- Require signing in on waking up from sleep. This node is optional.
-
-
-
-
-
-
-
-
-
- Sign-in on resume
-
- text/plain
-
-
-
-
- SleepTimeout
-
-
-
-
-
- 300
- The amount of time before the PC sleeps, given in seconds. 0 means the PC never sleeps. Default is 5 minutes. This node is optional.
-
-
-
-
-
-
-
-
-
- Sleep timeout
-
- text/plain
-
-
-
-
- EnableAccountManager
-
-
-
-
-
- true
- Enable the account manager for shared PC mode.
-
-
-
-
-
-
-
-
-
- Enable account manager
-
- text/plain
-
-
-
-
- AccountModel
-
-
-
-
-
- 0
- Configures which type of accounts are allowed to use the PC. Allowed values: 0 (only guest), 1 (domain-joined only), 2 (domain-joined and guest).
-
-
-
-
-
-
-
-
-
- Account model
-
- text/plain
-
-
-
-
- DeletionPolicy
-
-
-
-
-
- 1
- Configures when accounts will be deleted. Allowed values: 0 (delete immediately), 1 (delete at disk space threshold).
-
-
-
-
-
-
-
-
-
- Account deletion policy
-
- text/plain
-
-
-
-
- DiskLevelDeletion
-
-
-
-
-
- 25
- Accounts will start being deleted when available disk space falls below this threshold, given as percent of total disk capacity. Accounts that have been inactive the longest will be deleted first.
-
-
-
-
-
-
-
-
-
- Disk space threshold for account deletion
-
- text/plain
-
-
-
-
- DiskLevelCaching
-
-
-
-
-
- 50
- Stop deleting accounts when available disk space reaches this threshold, given as percent of total disk capacity.
-
-
-
-
-
-
-
-
-
- Disk space threshold for account caching
-
- text/plain
-
-
-
-
- RestrictLocalStorage
-
-
-
-
-
- true
- Restricts the user from using local storage. This node is optional.
-
-
-
-
-
-
-
-
-
- Restrict local storage
-
- text/plain
-
-
-
-
- KioskModeAUMID
-
-
-
-
-
- Specifies the AUMID of the app to use with assigned access. This node is optional.
-
-
-
-
-
-
-
-
-
- Kiosk mode AUMID
-
- text/plain
-
-
-
-
- KioskModeUserTileDisplayText
-
-
-
-
-
- Specifies the display text for the account shown on the sign-in screen which launches the app specified by KioskModeAUMID. This node is optional.
-
-
-
-
-
-
-
-
-
- Kiosk mode user tile display text
-
- text/plain
-
-
-
-
- InactiveThreshold
-
-
-
-
-
- 30
- Accounts will start being deleted when they have not been logged on during the specified period, given as number of days.
-
-
-
-
-
-
-
-
-
- Account inactive threshold
-
- text/plain
-
-
-
-
- MaxPageFileSizeMB
-
-
-
-
-
- 1024
- Maximum size of the paging file in MB. Applies only to systems with less than 32 GB storage and at least 3 GB of RAM. This node is optional.
-
-
-
-
-
-
-
-
-
- Maximum PageFile size
-
- text/plain
-
-
-
+ EnableSharedPCMode
+
+
+
+
+
+
+
+ false
+ Setting this node to "true" triggers the action to configure a device to Shared PC mode.
+
+
+
+
+
+
+
+
+
+ Enable shared PC mode
+
+
+
+
+
+ false
+ Not configured
+
+
+ true
+ Enabled
+
+
+
+
+ EnableSharedPCModeWithOneDriveSync
+
+
+
+
+
+
+
+ false
+ Setting this node to “1” triggers the action to configure a device to Shared PC mode with OneDrive sync turned on
+
+
+
+
+
+
+
+
+
+ Enable Shared PC mode with OneDrive sync
+
+
+
+
+ 10.0.22621
+ 1.2
+
+
+
+ false
+ Not configured
+
+
+ true
+ Enabled
+
+
+
+
+
+ EnableWindowsInsiderPreviewFlighting
+
+
+
+
+
+
+
+ false
+ Setting this node to “1” enables Windows Insider Preview flighting and the ability to receive insider preview builds.
+
+
+
+
+
+
+
+
+
+ Enable WIP Flighting
+
+
+
+
+ 10.0.22621
+ 1.2
+
+
+
+ false
+ Not configured
+
+
+ true
+ WIP builds are Enabled
+
+
+
+
+
+ SetEduPolicies
+
+
+
+
+
+
+
+ false
+ Set a list of EDU policies.
+
+
+
+
+
+
+
+
+
+ Set EDU policies
+
+
+
+
+
+ false
+ Not configured
+
+
+ true
+ Enabled
+
+
+
+
+
+ SetPowerPolicies
+
+
+
+
+
+
+
+ false
+ Set a list of power policies. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+
+
+ Set power policies
+
+
+
+
+
+ false
+ Not configured
+
+
+ true
+ Enabled
+
+
+
+
+
+ MaintenanceStartTime
+
+
+
+
+
+
+
+ 0
+ Daily start time of maintenance hour. Given in minutes from midnight. Default is 0 (12am). If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+
+
+ Maintenance start time
+
+
+
+
+ [0-1440]
+
+
+
+
+ SignInOnResume
+
+
+
+
+
+
+
+ false
+ Require signing in on waking up from sleep. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+
+
+ Sign-in on resume
+
+
+
+
+
+ false
+ False
+
+
+ true
+ True
+
+
+
+
+
+ SleepTimeout
+
+
+
+
+
+
+
+ 300
+ The amount of time before the PC sleeps, giving in seconds. 0 means the PC never sleeps. Default is 5 minutes. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+
+
+ Sleep timeout
+
+
+
+
+ [0-4294967295]
+
+
+
+
+ EnableAccountManager
+
+
+
+
+
+
+
+ false
+ Enable the account manager for shared PC mode. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+
+
+ Enable account manager
+
+
+
+
+
+ false
+ False
+
+
+ true
+ True
+
+
+
+
+
+ AccountModel
+
+
+
+
+
+
+
+ 0
+ Configures which type of accounts are allowed to use the PC. Allowed values: 0 (only guest), 1 (domain-joined only), 2 (domain-joined and guest). If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+
+
+ Account model
+
+
+
+
+
+ 0
+ Only guest accounts are allowed.
+
+
+ 1
+ Only domain-joined accounts are allowed.
+
+
+ 2
+ Domain-joined and guest accounts are allowed.
+
+
+
+
+
+ DeletionPolicy
+
+
+
+
+
+
+
+ 1
+ Configures when accounts will be deleted. Allowed values: 0 (delete immediately), 1 (delete at disk space threshold), 2 (Delete at disk space threshold and inactive threshold). If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+
+
+ Account deletion policy
+
+
+
+
+
+ 0
+ Delete immediately.
+
+
+ 1
+ Delete at disk space threshold
+
+
+ 2
+ Delete at disk space threshold and inactive threshold
+
+
+
+
+
+ DiskLevelDeletion
+
+
+
+
+
+
+
+ 25
+ Accounts will start being deleted when available disk space falls below this threshold, given as percent of total disk capacity. Accounts that have been inactive the longest will be deleted first. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+
+
+ Disk space threshold for account deletion
+
+
+
+
+ [0-100]
+
+
+
+
+ DiskLevelCaching
+
+
+
+
+
+
+
+ 50
+ Stop deleting accounts when available disk space reaches this threshold, given as percent of total disk capacity. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+
+
+ Disk space threshold for account caching
+
+
+
+
+ [0-100]
+
+
+
+
+ RestrictLocalStorage
+
+
+
+
+
+
+
+ false
+ Restricts the user from using local storage. This node is optional. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+
+
+ Restrict local storage
+
+
+
+
+ 10.0.15063
+ 1.1
+
+
+
+ false
+ False
+
+
+ true
+ True
+
+
+
+
+
+ KioskModeAUMID
+
+
+
+
+
+
+
+ Specifies the AUMID of the app to use with assigned access. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+
+
+ Kiosk mode AUMID
+
+
+
+
+ 10.0.15063
+ 1.1
+
+
+
+
+
+
+ KioskModeUserTileDisplayText
+
+
+
+
+
+
+
+ Specifies the display text for the account shown on the sign-in screen which launches the app specified by KioskModeAUMID. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+
+
+ Kiosk mode user tile display text
+
+
+
+
+ 10.0.15063
+ 1.1
+
+
+
+
+
+
+ InactiveThreshold
+
+
+
+
+
+
+
+ 30
+ Accounts will start being deleted when they have not been logged on during the specified period, given as number of days.
+
+
+
+
+
+
+
+
+
+ Account inactive threshold
+
+
+
+
+ 10.0.15063
+ 1.1
+
+
+ [0-4294967295]
+
+
+
+
+ MaxPageFileSizeMB
+
+
+
+
+
+
+
+ 1024
+ Maximum size of the paging file in MB. Applies only to systems with less than 32 GB storage and at least 3 GB of RAM. If used, this value must be set before the action on the EnableSharedPCMode node is taken.
+
+
+
+
+
+
+
+
+
+ Maximum PageFile size
+
+
+
+
+ 10.0.15063
+ 1.1
+
+
+ [0-32768]
+
+
+
+
```
-## Related topics
-
-[SharedPC configuration service provider](sharedpc-csp.md)
-
-
-
-
-
-
-
-
-
+## Related articles
+[SharedPC configuration service provider reference](sharedpc-csp.md)