From bb1b6e7e849ce0604bf39c624d6e307bc9ad3725 Mon Sep 17 00:00:00 2001
From: Vinay Pamnani <37223378+vinaypamnani-msft@users.noreply.github.com>
Date: Fri, 24 Feb 2023 14:17:33 -0500
Subject: [PATCH] SurfaceHub CSP
---
.../client-management/mdm/surfacehub-csp.md | 2918 +++++++++++++++--
.../mdm/surfacehub-ddf-file.md | 2845 ++++++++++------
2 files changed, 4462 insertions(+), 1301 deletions(-)
diff --git a/windows/client-management/mdm/surfacehub-csp.md b/windows/client-management/mdm/surfacehub-csp.md
index 9ddb730b42..8053fbaba7 100644
--- a/windows/client-management/mdm/surfacehub-csp.md
+++ b/windows/client-management/mdm/surfacehub-csp.md
@@ -1,96 +1,296 @@
---
title: SurfaceHub CSP
-description: The SurfaceHub configuration service provider (CSP) is used to configure Microsoft Surface Hub settings. This CSP was added in Windows 10, version 1511.
-ms.reviewer:
+description: Learn more about the SurfaceHub CSP.
+author: vinaypamnani-msft
manager: aaroncz
ms.author: vinpa
-ms.topic: article
+ms.date: 02/24/2023
+ms.localizationpriority: medium
ms.prod: windows-client
ms.technology: itpro-manage
-author: vinaypamnani-msft
-ms.date: 07/28/2017
+ms.topic: reference
---
+
+
+
# SurfaceHub CSP
-The SurfaceHub configuration service provider (CSP) is used to configure Microsoft Surface Hub settings. This CSP was added in Windows 10, version 1511, and later.
+> [!IMPORTANT]
+> This CSP contains preview policies that are under development and only applicable for [Windows Insider Preview builds](/windows-insider/). These policies are subject to change and may have dependencies on other features or services in preview.
-The following example shows the SurfaceHub CSP management objects in tree format.
+
+
+The SurfaceHub configuration service provider (CSP) is used to configure Microsoft Surface Hub settings.
+
+
+The following example shows the SurfaceHub configuration service provider in tree format.
+
+```text
+./Vendor/MSFT/SurfaceHub
+--- AutopilotSelfdeploy
+------ FriendlyName
+------ Password
+------ UserPrincipalName
+--- DeviceAccount
+------ CalendarSyncEnabled
+------ DomainName
+------ Email
+------ ErrorContext
+------ ExchangeModernAuthEnabled
+------ ExchangeServer
+------ Password
+------ PasswordRotationPeriod
+------ SipAddress
+------ UserName
+------ UserPrincipalName
+------ ValidateAndCommit
+--- Dot3
+------ EapUserData
+------ LanProfile
+--- InBoxApps
+------ Connect
+--------- AutoLaunch
+------ SkypeForBusiness
+--------- DomainName
+------ Teams
+--------- Configurations
+------ Welcome
+--------- AutoWakeScreen
+--------- CurrentBackgroundPath
+--------- MeetingInfoOption
+------ Whiteboard
+--------- SharingDisabled
+--------- SignInDisabled
+--------- TelemetryDisabled
+------ WirelessProjection
+--------- Channel
+--------- Enabled
+--------- PINRequired
+--- MaintenanceHoursSimple
+------ Hours
+--------- Duration
+--------- StartTime
+--- Management
+------ GroupName
+------ GroupSid
+--- MOMAgent
+------ WorkspaceID
+------ WorkspaceKey
+--- Properties
+------ AllowAutoProxyAuth
+------ AllowSessionResume
+------ DefaultVolume
+------ DisableSigninSuggestions
+------ DoNotShowMyMeetingsAndFiles
+------ FriendlyName
+------ ProxyServers
+------ ScreenTimeout
+------ SessionTimeout
+------ SleepMode
+------ SleepTimeout
+------ SurfaceHubMeetingMode
+------ VtcAppPackageId
```
-./Vendor/MSFT
-SurfaceHub
-----DeviceAccount
---------DomainName
---------UserName
---------UserPrincipalName
---------Password
---------ValidateAndCommit
---------ExchangeServer
---------SipAddress
---------Email
---------CalendarSyncEnabled
---------ErrorContext
---------PasswordRotationEnabled
-----MaintenanceHoursSimple
---------Hours
-------------StartTime
-------------Duration
-----InBoxApps
---------SkypeForBusiness
-------------DomainName
---------Welcome
-------------AutoWakeScreen
-------------CurrentBackgroundPath
-------------MeetingInfoOption
---------Whiteboard
-------------SharingDisabled
-------------SigninDisabled
-------------TelemeteryDisabled
---------WirelessProjection
-------------PINRequired
-------------Enabled
-------------Channel
---------Connect
-------------AutoLaunch
-----Properties
---------FriendlyName
---------DefaultVolume
---------DefaultAutomaticFraming
---------ScreenTimeout
---------SessionTimeout
---------SleepTimeout
---------AllowSessionResume
---------AllowAutoProxyAuth
---------ProxyServers
---------DisableSigninSuggestions
---------DoNotShowMyMeetingsAndFiles
-----Management
---------GroupName
---------GroupSid
-----MOMAgent
---------WorkspaceID
---------WorkspaceKey
+
+
+
+## AutopilotSelfdeploy
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/AutopilotSelfdeploy
```
+
-**./Vendor/MSFT/SurfaceHub**
-The root node for the Surface Hub configuration service provider.
+
+
+Node for setting Autopilot self-deployment mode device account information. This information is stored and committed by the Autopilot client during the Enrollment Status Page phase of OOBE for Surface Hub devices that are using Autopilot self-deploying mode. These values should be set only during the first sync phase of enrollment and are ignored at any other time.
+
-**DeviceAccount**
-Node for setting device account information. A device account is a Microsoft Exchange account that is connected with Skype for Business, which allows people to join scheduled meetings, make Skype for Business calls, and share content from the device. See the Surface Hub administrator guide for more information about setting up a device account.
+
+
+
-To use a device account from Azure Active Directory
+
+**Description framework properties**:
-1. Set the UserPrincipalName (for Azure AD).
-2. Set a valid Password.
-3. Execute ValidateAndCommit to validate the specified username and password combination against Azure AD.
-4. Get the ErrorContext in case something goes wrong during validation.
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+| Case Sensitive | True |
+
+
+
+
+
+
+
+
+### AutopilotSelfdeploy/FriendlyName
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/AutopilotSelfdeploy/FriendlyName
+```
+
+
+
+
+The device friendly name set during Autopilot self-deploying mode on Surface Hub. Get is allowed here but only returns a blank.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
+
+
+
+
+
+
+
+
+### AutopilotSelfdeploy/Password
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/AutopilotSelfdeploy/Password
+```
+
+
+
+
+Password for the device account. Get is allowed here, but will always return a blank.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
+
+
+
+
+
+
+
+
+### AutopilotSelfdeploy/UserPrincipalName
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/AutopilotSelfdeploy/UserPrincipalName
+```
+
+
+
+
+User principal name (UPN) of the device account. Autopilot on Surface Hub only supports Azure Active Directory, and this should specify the UPN of the device account. Get is allowed here but only returns a blank.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
+
+
+
+
+
+
+
+
+## DeviceAccount
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/DeviceAccount
+```
+
+
+
+
+Node for setting device account information. A device account is a Microsoft Exchange account that is connected with Skype for Business, which allows people to join scheduled meetings, make Skype for Business calls, and share content from the device. See the [Surface Hub administrator guide](/surface-hub/) for more information about setting up a device account. To use a device account from Azure Active Directory: 1. Set the UserPrincipalName (for Azure AD). 2. Set a valid Password. 3. Execute ValidateAndCommit to validate the specified username and password combination against Azure AD. 4. Get the ErrorContext in case something goes wrong during validation.
+
+
+
+
> [!NOTE]
> If the device cannot auto-discover the Exchange server and Session Initiation Protocol (SIP) address from this information, you should specify the ExchangeServer and SipAddress.
+
+
+**Description framework properties**:
-Here's a SyncML example.
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+| Case Sensitive | True |
+
+
+
+
+**Example**:
```xml
@@ -139,98 +339,159 @@ Here's a SyncML example.
```
+
-To use a device account from Active Directory:
+
-1. Set the DomainName.
-2. Set the UserName.
-3. Set a valid Password.
-4. Execute the ValidateAndCommit node.
+
+### DeviceAccount/CalendarSyncEnabled
-**DeviceAccount/DomainName**
+
+| 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 1511 [10.0.10586] and later |
+
-Domain of the device account when you're using Active Directory. To use a device account from Active Directory, you should specify both DomainName and UserName for the device account.
+
+```Device
+./Vendor/MSFT/SurfaceHub/DeviceAccount/CalendarSyncEnabled
+```
+
-- The data type is string.
-- Supported operation is Get and Replace.
+
+
+Specifies whether calendar sync and other Exchange server services is enabled.
+
-**DeviceAccount/UserName**
+
+
+
-Username of the device account when you're using Active Directory. To use a device account from Active Directory, you should specify both DomainName and UserName for the device account.
+
+**Description framework properties**:
-- The data type is string.
-- Supported operation is Get and Replace.
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Get, Replace |
+
-**DeviceAccount/UserPrincipalName**
+
+**Allowed values**:
-User principal name (UPN) of the device account. To use a device account from Azure Active Directory or a hybrid deployment, you should specify the UPN of the device account.
+| Value | Description |
+|:--|:--|
+| false | Disabled. |
+| true | Enabled. |
+
-- The data type is string.
-- Supported operation is Get and Replace.
+
+
+
-**DeviceAccount/SipAddress**
+
-Session Initiation Protocol (SIP) address of the device account. Normally, the device will try to auto-discover the SIP. This field is only required if auto-discovery fails.
+
+### DeviceAccount/DomainName
-- The data type is string.
-- Supported operation is Get and Replace.
+
+| 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 1511 [10.0.10586] and later |
+
-**DeviceAccount/Password**
+
+```Device
+./Vendor/MSFT/SurfaceHub/DeviceAccount/DomainName
+```
+
-Password for the device account.
+
+
+Domain of the device account when you are using Active Directory. To use a device account from Active Directory, you should specify both DomainName and UserName for the device account.
+
-- The data type is string.
-- Supported operation is Get and Replace. The operation Get is allowed, but it will always return a blank.
+
+
+
-**DeviceAccount/ValidateAndCommit**
+
+**Description framework properties**:
-This method validates the data provided and then commits the changes.
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
-- The data type is string.
-- Supported operation is Execute.
+
+
+
-**DeviceAccount/Email**
+
-Email address of the device account. The data type is string.
+
+### DeviceAccount/Email
-**DeviceAccount/
-PasswordRotationEnabled**
+
+| 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 1511 [10.0.10586] and later |
+
-Specifies whether automatic password rotation is enabled. If you enforce a password expiration policy on the device account, use this setting to allow the device to manage its own password by changing it frequently, without requiring you to manually update the account information when the password expires. You can reset the password at any time using Active Directory (or Azure AD).
+
+```Device
+./Vendor/MSFT/SurfaceHub/DeviceAccount/Email
+```
+
-Valid values:
+
+
+Email address of the device account.
+
-- 0 - password rotation enabled
-- 1 - disabled
+
+
+
-It performs the following:
-- The data type is integer.
-- Supported operation is Get and Replace.
+
+**Description framework properties**:
-**DeviceAccount/ExchangeServer**
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
-Exchange server of the device account. Normally, the device will try to auto-discover the Exchange server. This field is only required if auto-discovery fails.
+
+
+
-- The data type is string.
-- Supported operation is Get and Replace.
+
-**DeviceAccount/ExchangeModernAuthEnabled**
+
+### DeviceAccount/ErrorContext
-Added in KB4598291 for Windows 10, version 20H2. Specifies, whether Device Account calendar sync will attempt to use token-based Modern Authentication to connect to the Exchange Server. Default value is True.
+
+| 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 1511 [10.0.10586] and later |
+
-- The data type is boolean.
-- Supported operation is Get and Replace.
+
+```Device
+./Vendor/MSFT/SurfaceHub/DeviceAccount/ErrorContext
+```
+
-**DeviceAccount/CalendarSyncEnabled**
+
+
+If there is an error calling ValidateAndCommit, there will be additional context for that error in this node.
+
-Specifies, whether calendar sync and other Exchange server services is enabled.
-
-- The data type is boolean.
-- Supported operation is Get and Replace.
-
-**DeviceAccount/ErrorContext**
-
-If there's an error calling ValidateAndCommit, there's another context for that error in this node. Here are the possible error values:
+
+
+Possible error values:
| **ErrorContext value** | **Stage where error occurred** | **Description and suggestions** |
| --- | --- | --- |
@@ -240,315 +501,2350 @@ If there's an error calling ValidateAndCommit, there's another context for that
| 4 | Validating Exchange server address | Unable to validate the Exchange server address. Ensure the ExchangeServer field is valid. |
| 5 | Saving account information | Unable to save account details to the system. |
| 6 | Validating EAS policies | The device account uses an unsupported EAS policy. Ensure the EAS policy is configured correctly according to the admin guide. |
+
-It performs the following:
-- The data type is integer.
-- Supported operation is Get.
+
+**Description framework properties**:
-**MaintenanceHoursSimple/Hours**
-Node for maintenance schedule.
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Get |
+
-**MaintenanceHoursSimple/Hours/StartTime**
+
+
+
-Specifies the start time for maintenance hours in minutes from midnight. For example, to set a 2:00 am start time, set this value to 120.
+
-- The data type is integer.
-- Supported operation is Get and Replace.
+
+### DeviceAccount/ExchangeModernAuthEnabled
-**MaintenanceHoursSimple/Hours/Duration**
+
+| 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 2004 [10.0.19041.789] and later
:heavy_check_mark: Windows 10, version 2009 [10.0.19042.789] and later
:heavy_check_mark: Windows Insider Preview [99.9.9999] |
+
-Specifies the duration of maintenance window in minutes. For example, to set a 3-hour duration, set this value to 180.
+
+```Device
+./Vendor/MSFT/SurfaceHub/DeviceAccount/ExchangeModernAuthEnabled
+```
+
-- The data type is integer.
-- Supported operation is Get and Replace.
+
+
+Specifies whether Device Account calendar sync will attempt to use token-based Modern Authentication to connect to the Exchange Server.
+
-**InBoxApps**
+
+
+
+
+**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. |
+
+
+
+
+
+
+
+
+
+### DeviceAccount/ExchangeServer
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/DeviceAccount/ExchangeServer
+```
+
+
+
+
+Exchange server of the device account. Normally, the device will try to auto-discover the Exchange server. This field is only required if auto-discovery fails.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
+
+
+
+
+
+
+
+
+### DeviceAccount/Password
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/DeviceAccount/Password
+```
+
+
+
+
+Password for the device account. Get is allowed here, but will always return a blank.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
+
+
+
+
+
+
+
+
+### DeviceAccount/PasswordRotationPeriod
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/DeviceAccount/PasswordRotationPeriod
+```
+
+
+
+
+Specifies whether automatic password rotation is enabled. If you enforce a password expiration policy on the device account, use this setting to allow the device to manage its own password by changing it frequently, without requiring you to manually update the account information when the password expires. You can reset the password at any time using Active Directory (or Azure AD).
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Get, Replace |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| 0 | Password rotation enabled. |
+| 1 | Disabled. |
+
+
+
+
+
+
+
+
+
+### DeviceAccount/SipAddress
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/DeviceAccount/SipAddress
+```
+
+
+
+
+Session Initiation Protocol (SIP) address of the device account. Normally, the device will try to auto-discover the SIP. This field is only required if auto-discovery fails.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
+
+
+
+
+
+
+
+
+### DeviceAccount/UserName
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/DeviceAccount/UserName
+```
+
+
+
+
+Username of the device account when you are using Active Directory. To use a device account from Active Directory, you should specify both DomainName and UserName for the device account.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
+
+
+
+
+
+
+
+
+### DeviceAccount/UserPrincipalName
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/DeviceAccount/UserPrincipalName
+```
+
+
+
+
+User principal name (UPN) of the device account. To use a device account from Azure Active Directory or a hybrid deployment, you should specify the UPN of the device account.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
+
+
+
+
+
+
+
+
+### DeviceAccount/ValidateAndCommit
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/DeviceAccount/ValidateAndCommit
+```
+
+
+
+
+This method validates the data provided and then commits the changes.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Exec |
+
+
+
+
+
+
+
+
+
+## Dot3
+
+
+| 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.64] and later
:heavy_check_mark: Windows 10, version 1803 [10.0.17134] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/Dot3
+```
+
+
+
+
+Parent node.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+
+
+
+
+
+
+
+
+
+### Dot3/EapUserData
+
+
+| 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.64] and later
:heavy_check_mark: Windows 10, version 1803 [10.0.17134] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/Dot3/EapUserData
+```
+
+
+
+
+Used to specify credentials to authenticate device to the network.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
+
+
+
+
+
+
+
+
+### Dot3/LanProfile
+
+
+| 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.64] and later
:heavy_check_mark: Windows 10, version 1803 [10.0.17134] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/Dot3/LanProfile
+```
+
+
+
+
+Used to specify credentials to authenticate device to the network.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
+
+
+
+
+
+
+
+
+## InBoxApps
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/InBoxApps
+```
+
+
+
+
Node for the in-box app settings.
+
-**InBoxApps/SkypeForBusiness**
+
+
+
-Added in Windows 10, version 1703. Node for the Skype for Business settings.
+
+**Description framework properties**:
-**InBoxApps/SkypeForBusiness/DomainName**
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+
-Added in Windows 10, version 1703. Specifies the domain of the Skype for Business account when you're using Active Directory. For more information, see Set up Skype for Business Online.
+
+
+
-- The data type is string.
-- Supported operation is Get and Replace.
+
-**InBoxApps/Welcome**
+
+### InBoxApps/Connect
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/InBoxApps/Connect
+```
+
+
+
+
+Node for the Connect app.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+
+
+
+
+
+
+
+
+
+#### InBoxApps/Connect/AutoLaunch
+
+
+| 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/SurfaceHub/InBoxApps/Connect/AutoLaunch
+```
+
+
+
+
+Specifies whether to automatically launch the Connect app whenever a projection is initiated. If this setting is true, the Connect app will be automatically launched. If false, the user will need to launch the Connect app manually from the Hub's settings.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Get, Replace |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| false | Disabled. |
+| true | Enabled. |
+
+
+
+
+
+
+
+
+
+### InBoxApps/SkypeForBusiness
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/InBoxApps/SkypeForBusiness
+```
+
+
+
+
+Node for the Skype for Business settings.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+
+
+
+
+
+
+
+
+
+#### InBoxApps/SkypeForBusiness/DomainName
+
+
+| 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/SurfaceHub/InBoxApps/SkypeForBusiness/DomainName
+```
+
+
+
+
+Specifies the domain of the Skype for Business account when you are using Active Directory. For more information, see
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
+
+
+
+
+
+
+
+
+### InBoxApps/Teams
+
+
+| 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 2004 [10.0.19041.450] and later
:heavy_check_mark: Windows 10, version 2009 [10.0.19042] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/InBoxApps/Teams
+```
+
+
+
+
+This node controls policies specific to the Teams App on Surface Hub.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+
+
+
+
+
+
+
+
+
+#### InBoxApps/Teams/Configurations
+
+
+| 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 2004 [10.0.19041.450] and later
:heavy_check_mark: Windows 10, version 2009 [10.0.19042] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/InBoxApps/Teams/Configurations
+```
+
+
+
+
+String to contain Teams policy configs.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
+
+
+
+
+
+
+
+
+### InBoxApps/Welcome
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/InBoxApps/Welcome
+```
+
+
+
+
Node for the welcome screen.
+
-**InBoxApps/Welcome/AutoWakeScreen**
+
+
+
-Automatically turn on the screen using motion sensors.
+
+**Description framework properties**:
-- The data type is boolean.
-- Supported operation is Get and Replace.
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+
-**InBoxApps/Welcome/CurrentBackgroundPath**
+
+
+
-Download location for image, to be used as the background during user sessions and on the welcome screen. To set this location, specify an https URL to a 32-bit PNG file (only PNGs are supported for security reasons). If any certificate authorities need to be trusted in order to access the URL, ensure they're valid and installed on the Hub. Otherwise, it may not be able to load the image.
+
-- The data type is string.
-- Supported operation is Get and Replace.
+
+#### InBoxApps/Welcome/AutoWakeScreen
-**InBoxApps/Welcome/MeetingInfoOption**
+
+| 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 1511 [10.0.10586] and later |
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/InBoxApps/Welcome/AutoWakeScreen
+```
+
+
+
+
+Setting for the screen to wake up and stay on with sensor activity.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Get, Replace |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| False | Disabled. |
+| True | Enabled. |
+
+
+
+
+
+
+
+
+
+#### InBoxApps/Welcome/CurrentBackgroundPath
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/InBoxApps/Welcome/CurrentBackgroundPath
+```
+
+
+
+
+Background image for the welcome screen. To set this, specify an https URL to a PNG file (only PNGs are supported for security reasons). If any certificate authorities need to be trusted in order to access the URL, please ensure they are valid and installed on the Hub, otherwise it may not be able to load the image.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
+
+
+
+
+
+
+
+
+#### InBoxApps/Welcome/MeetingInfoOption
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/InBoxApps/Welcome/MeetingInfoOption
+```
+
+
+
+
Meeting information displayed on the welcome screen.
+
-Valid values:
+
+
+
-- 0 - Organizer and time only
-- 1 - Organizer, time, and subject. Subject is hidden in private meetings.
+
+**Description framework properties**:
-It performs the following:
-- The data type is integer.
-- Supported operation is Get and Replace.
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Get, Replace |
+
-**InBoxApps/Whiteboard**
+
+**Allowed values**:
-Node for the Whiteboard app settings.
+| Value | Description |
+|:--|:--|
+| 0 | Organizer and time only. |
+| 1 | Organizer, time, and subject. Subject is hidden in private meetings. |
+
-**InBoxApps/Whiteboard/SharingDisabled**
+
+
+
-Invitations to collaborate from the Whiteboard app aren't allowed.
+
-- The data type is boolean.
-- Supported operation is Get and Replace.
+
+### InBoxApps/Whiteboard
-**InBoxApps/Whiteboard/SigninDisabled**
+
+| 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 1903 [10.0.18362.449] and later
:heavy_check_mark: Windows 10, version 1909 [10.0.18363] and later |
+
-Sign-ins from the Whiteboard app aren't allowed.
+
+```Device
+./Vendor/MSFT/SurfaceHub/InBoxApps/Whiteboard
+```
+
-- The data type is boolean.
-- Supported operation is Get and Replace.
+
+
+This node controls policies specific to the Whiteboard App on Surface Hub.
+
-**InBoxApps/Whiteboard/TelemeteryDisabled**
+
+
+
-Telemetry collection from the Whiteboard app isn't allowed.
+
+**Description framework properties**:
-- The data type is boolean.
-- Supported operation is Get and Replace.
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+
-**InBoxApps/WirelessProjection**
+
+
+
+
+
+
+#### InBoxApps/Whiteboard/SharingDisabled
+
+
+| 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 1903 [10.0.18362.449] and later
:heavy_check_mark: Windows 10, version 1909 [10.0.18363] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/InBoxApps/Whiteboard/SharingDisabled
+```
+
+
+
+
+When enabled, prevents a user from initiating a collaborative session on the device.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Get, Replace |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| False | Sharing enabled. |
+| True | Sharing disabled. |
+
+
+
+
+
+
+
+
+
+#### InBoxApps/Whiteboard/SignInDisabled
+
+
+| 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 1903 [10.0.18362.449] and later
:heavy_check_mark: Windows 10, version 1909 [10.0.18363] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/InBoxApps/Whiteboard/SignInDisabled
+```
+
+
+
+
+When enabled, prevents a user from Signing into Whiteboard on the device.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Get, Replace |
+| Default Value | False |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| False (Default) | Sign in enabled. |
+| True | Sign in disabled. |
+
+
+
+
+
+
+
+
+
+#### InBoxApps/Whiteboard/TelemetryDisabled
+
+
+| 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 1903 [10.0.18362.449] and later
:heavy_check_mark: Windows 10, version 1909 [10.0.18363] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/InBoxApps/Whiteboard/TelemetryDisabled
+```
+
+
+
+
+When enabled, prevents Whiteboard from sending telemetry from the device.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Get, Replace |
+| Default Value | False |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| False (Default) | Telemetry enabled. |
+| True | Telemetry disabled. |
+
+
+
+
+
+
+
+
+
+### InBoxApps/WirelessProjection
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/InBoxApps/WirelessProjection
+```
+
+
+
+
Node for the wireless projector app settings.
+
-**InBoxApps/WirelessProjection/PINRequired**
+
+
+
-Users must enter a PIN to wireless project to the device.
+
+**Description framework properties**:
-- The data type is boolean.
-- Supported operation is Get and Replace.
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+
-**InBoxApps/WirelessProjection/Enabled**
+
+
+
-Enables wireless projection to the device.
+
-- The data type is boolean.
-- Supported operation is Get and Replace.
+
+#### InBoxApps/WirelessProjection/Channel
-**InBoxApps/WirelessProjection/Channel**
+
+| 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 1511 [10.0.10586] and later |
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/InBoxApps/WirelessProjection/Channel
+```
+
+
+
+
Wireless channel to use for Miracast operation. The supported channels are defined by the Wi-Fi Alliance Wi-Fi Direct specification.
+
+
+
|**Compatibility**|**Values**|
|--- |--- |
|Works with all Miracast senders in all regions|1, 3, 4, 5, 6, 7, 8, 9, 10, 11|
|Works with all 5ghz band Miracast senders in all regions|36, 40, 44, 48|
|Works with all 5ghz band Miracast senders in all regions except Japan|149, 153, 157, 161, 165|
-The default value is 255. Outside of regulatory concerns, if the channel is configured incorrectly, the driver will either not boot or will broadcast on the wrong channel (which senders won't be looking for).
+Outside of regulatory concerns, if the channel is configured incorrectly, the driver will either not boot or will broadcast on the wrong channel (which senders won't be looking for).
+
-- The data type is integer.
-- Supported operation is Get and Replace.
+
+**Description framework properties**:
-**InBoxApps/Connect**
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Get, Replace |
+| Default Value | 255 |
+
-Added in Windows 10, version 1703. Node for the Connect app.
+
+
+
-**InBoxApps/Connect/AutoLaunch**
+
-Added in Windows 10, version 1703. Specifies, whether to automatically launch the Connect app whenever a projection is initiated.
+
+#### InBoxApps/WirelessProjection/Enabled
-If this setting is true, the Connect app will be automatically launched. If false, the user will need to launch the Connect app manually from the Hub’s settings.
+
+| 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 1511 [10.0.10586] and later |
+
-- The data type is boolean.
-- Supported operation is Get and Replace.
+
+```Device
+./Vendor/MSFT/SurfaceHub/InBoxApps/WirelessProjection/Enabled
+```
+
-**Properties**
+
+
+Enables wireless projection to the device.
+
-Node for the device properties.
+
+
+
-**Properties/FriendlyName**
+
+**Description framework properties**:
-Friendly name of the device. Specifies the name that users see when they want wireless project to the device.
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Get, Replace |
+
-- The data type is string.
-- Supported operation is Get and Replace.
+
+**Allowed values**:
-**Properties/DefaultVolume**
+| Value | Description |
+|:--|:--|
+| false | Disabled. |
+| true | Enabled. |
+
-Added in Windows 10, version 1703. Specifies the default volume value for a new session. Permitted values are 0-100. The default is 45.
+
+
+
-- The data type is integer.
-- Supported operation is Get and Replace.
+
-**Properties/DefaultAutomaticFraming**
+
+#### InBoxApps/WirelessProjection/PINRequired
-Added in KB5010415 for Windows 10, version 20H2. Specifies whether the Surface Hub 2 Smart Camera feature to automatically zoom and keep users centered in the video is enabled. Default value is True.
+
+| 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 1511 [10.0.10586] and later |
+
-- The data type is boolean.
-- Supported operation is Get and Replace.
+
+```Device
+./Vendor/MSFT/SurfaceHub/InBoxApps/WirelessProjection/PINRequired
+```
+
-**Properties/ScreenTimeout**
+
+
+Users must enter a PIN to wirelessly project to the device.
+
-Added in Windows 10, version 1703. Specifies the number of minutes until the Hub screen turns off.
+
+
+
-The following table shows the permitted values.
+
+**Description framework properties**:
-|**Value**|**Description**|
-|--- |--- |
-|0|Never time out|
-|1|1 minute|
-|2|2 minutes|
-|3|3 minutes|
-|5|5 minutes (default)|
-|10|10 minutes|
-|15|15 minutes|
-|30|30 minutes|
-|60|1 hour|
-|120|2 hours|
-|240|4 hours|
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Get, Replace |
+
-It performs the following:
-- The data type is integer.
-- Supported operation is Get and Replace.
+
+**Allowed values**:
-**Properties/SessionTimeout**
+| Value | Description |
+|:--|:--|
+| false | Pin not required. |
+| true | Pin required. |
+
-Added in Windows 10, version 1703. Specifies the number of minutes until the session times out.
+
+
+
-The following table shows the permitted values.
+
-|**Value**|**Description**|
-|--- |--- |
-|0|Never time out|
-|1|1 minute (default)|
-|2|2 minutes|
-|3|3 minutes|
-|5|5 minutes|
-|10|10 minutes|
-|15|15 minutes|
-|30|30 minutes|
-|60|1 hour|
-|120|2 hours|
-|240|4 hours|
+
+## MaintenanceHoursSimple
-It performs the following:
-- The data type is integer.
-- Supported operation is Get and Replace.
+
+| 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 1511 [10.0.10586] and later |
+
-**Properties/SleepTimeout**
+
+```Device
+./Vendor/MSFT/SurfaceHub/MaintenanceHoursSimple
+```
+
-Added in Windows 10, version 1703. Specifies the number of minutes until the Hub enters sleep mode.
+
+
+Node for maintenance schedule.
+
-The following table shows the permitted values.
+
+
+
-|**Value**|**Description**|
-|--- |--- |
-|0|Never time out|
-|1|1 minute|
-|2|2 minutes|
-|3|3 minutes|
-|5|5 minutes (default)|
-|10|10 minutes|
-|15|15 minutes|
-|30|30 minutes|
-|60|1 hour|
-|120|2 hours|
-|240|4 hours|
+
+**Description framework properties**:
-It performs the following:
-- The data type is integer.
-- Supported operation is Get and Replace.
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+
-**Properties/SleepMode**
+
+
+
-Added in Windows 10, version 20H2. Specifies the type of sleep mode for the Surface Hub.
+
-Valid values:
+
+### MaintenanceHoursSimple/Hours
-- 0 - Connected Standby (default)
-- 1 - Hibernate
+
+| 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 1511 [10.0.10586] and later |
+
-It performs the following:
-- The data type is integer.
-- Supported operation is Get and Replace.
+
+```Device
+./Vendor/MSFT/SurfaceHub/MaintenanceHoursSimple/Hours
+```
+
-**Properties/AllowSessionResume**
+
+
+Node for maintenance schedule.
+
-Added in Windows 10, version 1703. Specifies whether to allow the ability to resume a session when the session times out.
+
+
+
-If this setting is true, the "Resume Session" feature will be available on the welcome screen when the screen is idle. If false, once the screen idles, the session will be automatically cleaned up as if the “End Session" feature was initiated.
+
+**Description framework properties**:
-- The data type is boolean.
-- Supported operation is Get and Replace.
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+
-**Properties/AllowAutoProxyAuth**
+
+
+
-Added in Windows 10, version 1703. Specifies whether to use the device account for proxy authentication.
+
-If this setting is true, the device account will be used for proxy authentication. If false, a separate account will be used.
+
+#### MaintenanceHoursSimple/Hours/Duration
-- The data type is boolean.
-- Supported operation is Get and Replace.
+
+| 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 1511 [10.0.10586] and later |
+
-**Properties/ProxyServers**
+
+```Device
+./Vendor/MSFT/SurfaceHub/MaintenanceHoursSimple/Hours/Duration
+```
+
-Added in KB4499162 for Windows 10, version 1703. Specifies hostnames of proxy servers to automatically provide device account credentials to before any user interaction (if AllowAutoProxyAuth is enabled). This is a semi-colon separated list of server names (FQDN), without any extra prefixes (for example, https://).
+
+
+Specifies the duration of maintenance window in minutes. For example, to set a 3-hour duration, set this value to 180.
+
-- The data type is string.
-- Supported operation is Get and Replace.
+
+
+
-**Properties/DisableSigninSuggestions**
+
+**Description framework properties**:
-Added in Windows 10, version 1703. Specifies whether to disable auto-populating of the sign-in dialog with invitees from scheduled meetings.
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Get, Replace |
+| Allowed Values | Range: `[0-1439]` |
+
-If this setting is true, the sign-in dialog won't be populated. If false, the dialog will auto-populate.
+
+
+
-- The data type is boolean.
-- Supported operation is Get and Replace.
+
-**Properties/DoNotShowMyMeetingsAndFiles**
+
+#### MaintenanceHoursSimple/Hours/StartTime
-Added in Windows 10, version 1703. Specifies whether to disable the "My meetings and files" feature in the Start menu, which shows the signed-in user's meetings and files from Office 365.
+
+| 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 1511 [10.0.10586] and later |
+
-If this setting is true, the “My meetings and files” feature won't be shown. When false, the “My meetings and files” feature will be shown.
+
+```Device
+./Vendor/MSFT/SurfaceHub/MaintenanceHoursSimple/Hours/StartTime
+```
+
-- The data type is boolean.
-- Supported operation is Get and Replace.
+
+
+Specifies the start time for maintenance hours in minutes from midnight. For example, to set a 2:00 am start time, set this value to 120.
+
-**MOMAgent**
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Get, Replace |
+| Allowed Values | Range: `[0-1439]` |
+
+
+
+
+
+
+
+
+
+## Management
+
+
+| 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.969] and later
:heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/Management
+```
+
+
+
+
+Not a supported scenario.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+
+
+
+
+
+
+
+
+
+### Management/GroupName
+
+
+| 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.969] and later
:heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/Management/GroupName
+```
+
+
+
+
+The name of the domain admin group to add to the administrators group on the device.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
+
+
+
+
+
+
+
+
+### Management/GroupSid
+
+
+| 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.969] and later
:heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/Management/GroupSid
+```
+
+
+
+
+The sid of the domain admin group to add to the administrators group on the device.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
+
+
+
+
+
+
+
+
+## MOMAgent
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/MOMAgent
+```
+
+
+
+
Node for the Microsoft Operations Management Suite.
+
-**MOMAgent/WorkspaceID**
+
+
+
-GUID identifying the Microsoft Operations Management Suite workspace ID to collect the data. Set this GUID to an empty string to disable the MOM agent.
+
+**Description framework properties**:
-- The data type is string.
-- Supported operation is Get and Replace.
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+
-**MOMAgent/WorkspaceKey**
+
+
+
-Primary key for authenticating with the workspace.
+
-- The data type is string.
-- Supported operation is Get and Replace. The Get operation is allowed, but it will always return an empty string.
+
+### MOMAgent/WorkspaceID
-## Related topics
+
+| 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 1511 [10.0.10586] and later |
+
-[Configuration service provider reference](index.yml)
+
+```Device
+./Vendor/MSFT/SurfaceHub/MOMAgent/WorkspaceID
+```
+
+
+
+
+GUID identifying the Microsoft Operations Management Suite workspace ID to collect the data. Set this to an empty string to disable the MOM agent.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
+
+
+
+
+
+
+
+
+### MOMAgent/WorkspaceKey
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/MOMAgent/WorkspaceKey
+```
+
+
+
+
+Primary key for authenticating with workspace. Will always return an empty string.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
+
+
+
+
+
+
+
+
+## Properties
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/Properties
+```
+
+
+
+
+Node for the device properties.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | node |
+| Access Type | Get |
+
+
+
+
+
+
+
+
+
+### Properties/AllowAutoProxyAuth
+
+
+| 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/SurfaceHub/Properties/AllowAutoProxyAuth
+```
+
+
+
+
+Specifies whether to use the device account for proxy authentication. If this setting is true, the device account will be used for proxy authentication. If false, a separate account will be used.
+
+
+
+
+
+
+
+**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. |
+
+
+
+
+
+
+
+
+
+### Properties/AllowSessionResume
+
+
+| 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/SurfaceHub/Properties/AllowSessionResume
+```
+
+
+
+
+Specifies whether to allow the ability to resume a session when the session times out. If this setting is true, the "Resume Session" feature will be available on the welcome screen when the screen is idle. If false, once the screen idles, the session will be automatically cleaned up as if the "End Session" feature was initiated.
+
+
+
+
+
+
+
+**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. |
+
+
+
+
+
+
+
+
+
+### Properties/DefaultVolume
+
+
+| 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/SurfaceHub/Properties/DefaultVolume
+```
+
+
+
+
+Specifies the default volume value for a new session.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Get, Replace |
+| Allowed Values | Range: `[0-100]` |
+| Default Value | 45 |
+
+
+
+
+
+
+
+
+
+### Properties/DisableSigninSuggestions
+
+
+| 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/SurfaceHub/Properties/DisableSigninSuggestions
+```
+
+
+
+
+Specifies whether to disable auto-populating of the sign-in dialog with invitees from scheduled meetings. If this setting is true, the sign-in dialog will not be populated. If false, the dialog will auto-populate.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Get, Replace |
+| Default Value | false |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| false (Default) | Dialog will auto-populate. |
+| true | Sign-in dialog will not be populated. |
+
+
+
+
+
+
+
+
+
+### Properties/DoNotShowMyMeetingsAndFiles
+
+
+| 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/SurfaceHub/Properties/DoNotShowMyMeetingsAndFiles
+```
+
+
+
+
+Specifies whether to disable the "My meetings and files" feature in the Start menu, which shows the signed-in user's meetings and files from Office 365. If this setting is true, the "My meetings and files" feature will not be shown. When false, the "My meetings and files" feature will be shown.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | bool |
+| Access Type | Get, Replace |
+| Default Value | false |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| true | "My meetings and files" feature will not be shown. |
+| false (Default) | The "My meetings and files" feature will be shown. |
+
+
+
+
+
+
+
+
+
+### Properties/FriendlyName
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/Properties/FriendlyName
+```
+
+
+
+
+Friendly name of the device. Specifies the name that users see when they want to wirelessly project to the device.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Get, Replace |
+
+
+
+
+
+
+
+
+
+### Properties/ProxyServers
+
+
+| 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 1511 [10.0.10586] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/Properties/ProxyServers
+```
+
+
+
+
+The list of known proxy servers to provide.
+
+
+
+
+Specifies hostnames of proxy servers to automatically provide device account credentials to before any user interaction (if AllowAutoProxyAuth is enabled). This is a semi-colon separated list of server names (FQDN), without any extra prefixes (for example, `https://`).
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Delete, Get, Replace |
+
+
+
+
+
+
+
+
+
+### Properties/ScreenTimeout
+
+
+| 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/SurfaceHub/Properties/ScreenTimeout
+```
+
+
+
+
+Specifies the number of minutes until the Hub screen turns off.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Get, Replace |
+| Default Value | 5 |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| 0 | Never time out. |
+| 1 | 1 minute. |
+| 2 | 2 minutes. |
+| 3 | 3 minutes. |
+| 5 (Default) | 5 minutes. |
+| 10 | 10 minutes. |
+| 15 | 15 minutes. |
+| 30 | 30 minutes. |
+| 60 | 1 hour. |
+| 120 | 2 hours. |
+| 240 | 4 hours. |
+
+
+
+
+
+
+
+
+
+### Properties/SessionTimeout
+
+
+| 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/SurfaceHub/Properties/SessionTimeout
+```
+
+
+
+
+Specifies the number of minutes until the session times out.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Get, Replace |
+| Default Value | 1 |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| 0 | Never time out. |
+| 1 (Default) | 1 minute. |
+| 2 | 2 minutes. |
+| 3 | 3 minutes. |
+| 5 | 5 minutes. |
+| 10 | 10 minutes. |
+| 15 | 15 minutes. |
+| 30 | 30 minutes. |
+| 60 | 1 hour. |
+| 120 | 2 hours. |
+| 240 | 4 hours. |
+
+
+
+
+
+
+
+
+
+### Properties/SleepMode
+
+
+| 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/SurfaceHub/Properties/SleepMode
+```
+
+
+
+
+Specifies the type of sleep mode for the Surface Hub.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Get, Replace |
+| Default Value | 0 |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| 0 (Default) | Connected Standby. |
+| 1 | Hibernate. |
+
+
+
+
+
+
+
+
+
+### Properties/SleepTimeout
+
+
+| 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/SurfaceHub/Properties/SleepTimeout
+```
+
+
+
+
+Specifies the number of minutes until the Hub enters sleep mode.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Get, Replace |
+| Default Value | 5 |
+
+
+
+**Allowed values**:
+
+| Value | Description |
+|:--|:--|
+| 0 | Never time out. |
+| 1 | 1 minute. |
+| 2 | 2 minutes. |
+| 3 | 3 minutes. |
+| 5 (Default) | 5 minutes. |
+| 10 | 10 minutes. |
+| 15 | 15 minutes. |
+| 30 | 30 minutes. |
+| 60 | 1 hour. |
+| 120 | 2 hours. |
+| 240 | 4 hours. |
+
+
+
+
+
+
+
+
+
+### Properties/SurfaceHubMeetingMode
+
+
+| 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.969] and later
:heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/Properties/SurfaceHubMeetingMode
+```
+
+
+
+
+Teams mode.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | int |
+| Access Type | Delete, Get, Replace |
+| Allowed Values | Range: `[0-2]` |
+| Default Value | 0 |
+
+
+
+
+
+
+
+
+
+### Properties/VtcAppPackageId
+
+
+| 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.969] and later
:heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
+
+
+
+```Device
+./Vendor/MSFT/SurfaceHub/Properties/VtcAppPackageId
+```
+
+
+
+
+App name.
+
+
+
+
+
+
+
+**Description framework properties**:
+
+| Property name | Property value |
+|:--|:--|
+| Format | chr (string) |
+| Access Type | Delete, Get, Replace |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Related articles
+
+[Configuration service provider reference](configuration-service-provider-reference.md)
diff --git a/windows/client-management/mdm/surfacehub-ddf-file.md b/windows/client-management/mdm/surfacehub-ddf-file.md
index b641ecada1..0f0117489c 100644
--- a/windows/client-management/mdm/surfacehub-ddf-file.md
+++ b/windows/client-management/mdm/surfacehub-ddf-file.md
@@ -1,1016 +1,1881 @@
---
title: SurfaceHub DDF file
-description: This topic shows the OMA DM device description framework (DDF) for the SurfaceHub configuration service provider. This CSP was added in Windows 10, version 1511.
-ms.reviewer:
+description: View the XML file containing the device description framework (DDF) for the SurfaceHub configuration service provider.
+author: vinaypamnani-msft
manager: aaroncz
ms.author: vinpa
-ms.topic: article
+ms.date: 02/24/2023
+ms.localizationpriority: medium
ms.prod: windows-client
ms.technology: itpro-manage
-author: vinaypamnani-msft
-ms.date: 12/05/2017
+ms.topic: reference
---
+
+
# SurfaceHub DDF file
-This topic shows the OMA DM device description framework (DDF) for the SurfaceHub configuration service provider. This CSP was added in Windows 10, version 1511.
-
-Looking for the DDF XML files? See [CSP DDF files download](configuration-service-provider-ddf.md).
-
-The XML below is the current version for this CSP.
+The following XML file contains the device description framework (DDF) for the SurfaceHub configuration service provider.
```xml
-]>
+]>
- 1.2
+ 1.2
+
+
+
+ SurfaceHub
+ ./Vendor/MSFT
+
+
+
+
+ The root node for the Surface Hub configuration service provider.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.10586
+ 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;
+
+
- SurfaceHub
- ./Vendor/MSFT
+ AutopilotSelfdeploy
+
+
+
+
+ Node for setting Autopilot self-deployment mode device account information. This information is stored and committed by the Autopilot client during the Enrollment Status Page phase of OOBE for Surface Hub devices that are using Autopilot self-deploying mode. These values should be set only during the first sync phase of enrollment and are ignored at any other time.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ UserPrincipalName
-
-
-
-
-
-
-
-
-
-
-
-
-
- com.microsoft/1.0/MDM/SurfaceHub
-
+
+
+
+
+ User principal name (UPN) of the device account. Autopilot on Surface Hub only supports Azure Active Directory, and this should specify the UPN of the device account. Get is allowed here but only returns a blank
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Password
+
+
+
+
+
+ Password for the device account. Get is allowed here, but will always return a blank.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ FriendlyName
+
+
+
+
+
+ The device friendly name set during Autopilot self-deploying mode on Surface Hub. Get is allowed here but only returns a blank
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ DeviceAccount
+
+
+
+
+ Node for setting device account information. A device account is a Microsoft Exchange account that is connected with Skype for Business, which allows people to join scheduled meetings, make Skype for Business calls, and share content from the device. See the Surface Hub administrator guide for more information about setting up a device account. To use a device account from Azure Active Directory: 1. Set the UserPrincipalName (for Azure AD). 2. Set a valid Password. 3. Execute ValidateAndCommit to validate the specified username and password combination against Azure AD. 4. Get the ErrorContext in case something goes wrong during validation.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ DomainName
+
+
+
+
+
+ Domain of the device account when you are using Active Directory. To use a device account from Active Directory, you should specify both DomainName and UserName for the device account.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ UserName
+
+
+
+
+
+ Username of the device account when you are using Active Directory. To use a device account from Active Directory, you should specify both DomainName and UserName for the device account.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ UserPrincipalName
+
+
+
+
+
+ User principal name (UPN) of the device account. To use a device account from Azure Active Directory or a hybrid deployment, you should specify the UPN of the device account.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Password
+
+
+
+
+
+ Password for the device account. Get is allowed here, but will always return a blank.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ValidateAndCommit
+
+
+
+
+ This method validates the data provided and then commits the changes.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ExchangeServer
+
+
+
+
+
+ Exchange server of the device account. Normally, the device will try to auto-discover the Exchange server. This field is only required if auto-discovery fails.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SipAddress
+
+
+
+
+
+ Session Initiation Protocol (SIP) address of the device account. Normally, the device will try to auto-discover the SIP. This field is only required if auto-discovery fails.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email
+
+
+
+
+
+ Email address of the device account.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CalendarSyncEnabled
+
+
+
+
+
+ Specifies whether calendar sync and other Exchange server services is enabled.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ false
+ Disabled
+
+
+ true
+ Enabled
+
+
+
+
+
+ ErrorContext
+
+
+
+
+ If there is an error calling ValidateAndCommit, there will be additional context for that error in this node.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PasswordRotationPeriod
+
+
+
+
+
+ Specifies whether automatic password rotation is enabled. If you enforce a password expiration policy on the device account, use this setting to allow the device to manage its own password by changing it frequently, without requiring you to manually update the account information when the password expires. You can reset the password at any time using Active Directory (or Azure AD).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 0
+ Password rotation enabled
+
+
+ 1
+ Disabled
+
+
+
+
+
+ ExchangeModernAuthEnabled
+
+
+
+
+
+ True
+ Specifies whether Device Account calendar sync will attempt to use token-based Modern Authentication to connect to the Exchange Server.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.19041.789, 10.19042.789, 99.9.9999
+ 1.0
+
+
+
+ False
+ Disabled
+
+
+ True
+ Enabled
+
+
+
+
+
+
+ MaintenanceHoursSimple
+
+
+
+
+ Node for maintenance schedule.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hours
+
+
+
+
+ Node for maintenance schedule.
+
+
+
+
+
+
+
+
+
+
+
+
- DeviceAccount
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- DomainName
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- UserName
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- UserPrincipalName
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- Password
-
-
-
-
-
- Get is allowed here, but will always return a blank.
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- ValidateAndCommit
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- ExchangeServer
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- SipAddress
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- Email
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- CalendarSyncEnabled
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- ErrorContext
-
-
-
-
- If there is an error calling ValidateAndCommit, there will be additional context for that error in this node.
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- PasswordRotationEnabled
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
+ StartTime
+
+
+
+
+
+ Specifies the start time for maintenance hours in minutes from midnight. For example, to set a 2:00 am start time, set this value to 120.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ [0-1439]
+
+
- MaintenanceHoursSimple
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Hours
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- StartTime
-
-
-
-
-
- Start time for maintenance hours in minutes from midnight
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- Duration
-
-
-
-
-
- Duration of maintenance window
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
-
-
- InBoxApps
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- SkypeForBusiness
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- DomainName
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
-
- Welcome
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- AutoWakeScreen
-
-
-
-
-
- Setting for the screen to wake up and stay on with sensor activity.
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- CurrentBackgroundPath
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- MeetingInfoOption
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
-
- WirelessProjection
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- PINRequired
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- Enabled
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- Channel
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
-
- Connect
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- AutoLaunch
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- FriendlyName
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- DefaultVolume
-
-
-
-
-
- 65
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- ScreenTimeout
-
-
-
-
-
- 5
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- SessionTimeout
-
-
-
-
-
- 1
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- SleepTimeout
-
-
-
-
-
- 5
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- AllowSessionResume
-
-
-
-
-
- true
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- AllowAutoProxyAuth
-
-
-
-
-
- true
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- DisableSigninSuggestions
-
-
-
-
-
- false
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- DoNotShowMyMeetingsAndFiles
-
-
-
-
-
- false
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
-
- Management
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- GroupName
-
-
-
-
-
- The name of the domain admin group to add to the administrators group on the device.
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- GroupSid
-
-
-
-
-
- The sid of the domain admin group to add to the administrators group on the device.
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
-
- MOMAgent
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- WorkspaceID
-
-
-
-
-
- GUID identifying the Microsoft Operations Management Suite workspace ID to collect the data. Set this to an empty string to disable the MOM agent.
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
-
- WorkspaceKey
-
-
-
-
-
- Primary key for authenticating with workspace. Will always return an empty string.
-
-
-
-
-
-
-
-
-
-
- text/plain
-
-
-
+ Duration
+
+
+
+
+
+ Specifies the duration of maintenance window in minutes. For example, to set a 3-hour duration, set this value to 180.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ [0-1439]
+
+
+
+
+ InBoxApps
+
+
+
+
+ Node for the in-box app settings.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SkypeForBusiness
+
+
+
+
+ Node for the Skype for Business settings.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ DomainName
+
+
+
+
+
+ Specifies the domain of the Skype for Business account when you are using Active Directory. For more information, see https://docs.microsoft.com/en-us/SkypeForBusiness/set-up-skype-for-business-online/set-up-skype-for-business-online?redirectSourcePath=%252fen-us%252farticle%252fSet-up-Skype-for-Business-Online-40296968-e779-4259-980b-c2de1c044c6e#bkmk_users
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.15063
+ 1.0
+
+
+
+
+
+
+
+ Welcome
+
+
+
+
+ Node for the welcome screen.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ AutoWakeScreen
+
+
+
+
+
+ Setting for the screen to wake up and stay on with sensor activity.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ False
+ Disabled
+
+
+ True
+ Enabled
+
+
+
+
+
+ CurrentBackgroundPath
+
+
+
+
+
+ Background image for the welcome screen. To set this, specify an https URL to a PNG file (only PNGs are supported for security reasons). If any certificate authorities need to be trusted in order to access the URL, please ensure they are valid and installed on the Hub, otherwise it may not be able to load the image.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MeetingInfoOption
+
+
+
+
+
+ Meeting information displayed on the welcome screen.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 0
+ Organizer and time only.
+
+
+ 1
+ Organizer, time, and subject. Subject is hidden in private meetings.
+
+
+
+
+
+
+ WirelessProjection
+
+
+
+
+ Node for the wireless projector app settings.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PINRequired
+
+
+
+
+
+ Users must enter a PIN to wirelessly project to the device.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ false
+ Pin not required
+
+
+ true
+ Pin required
+
+
+
+
+
+ Enabled
+
+
+
+
+
+ Enables wireless projection to the device.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ false
+ Disabled
+
+
+ true
+ Enabled
+
+
+
+
+
+ Channel
+
+
+
+
+
+ 255
+ Wireless channel to use for Miracast operation. The supported channels are defined by the Wi-Fi Alliance Wi-Fi Direct specification.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Connect
+
+
+
+
+ Node for the Connect app.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ AutoLaunch
+
+
+
+
+
+ Specifies whether to automatically launch the Connect app whenever a projection is initiated. If this setting is true, the Connect app will be automatically launched. If false, the user will need to launch the Connect app manually from the Hub’s settings.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.15063
+ 1.0
+
+
+
+ false
+ Disabled
+
+
+ true
+ Enabled
+
+
+
+
+
+
+ Whiteboard
+
+
+
+
+ This node controls policies specific to the Whiteboard App on Surface Hub.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.18363, 10.0.18362.449
+ 1.0
+
+
+
+ SignInDisabled
+
+
+
+
+
+ False
+ When enabled, prevents a user from Signing into Whiteboard on the device
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ False
+ Sign in enabled
+
+
+ True
+ Sign in disabled
+
+
+
+
+
+ TelemetryDisabled
+
+
+
+
+
+ False
+ When enabled, prevents Whiteboard from sending telemetry from the device
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ False
+ Telemetry enabled
+
+
+ True
+ Telemetry disabled
+
+
+
+
+
+ SharingDisabled
+
+
+
+
+
+ When enabled, prevents a user from initiating a collaborative session on the device
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ False
+ Sharing enabled
+
+
+ True
+ Sharing disabled
+
+
+
+
+
+
+ Teams
+
+
+
+
+ This node controls policies specific to the Teams App on Surface Hub
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.19042, 10.0.19041.450
+ 1.0
+
+
+
+ Configurations
+
+
+
+
+
+ String to contain Teams policy configs
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+ Node for the device properties.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ FriendlyName
+
+
+
+
+
+ Friendly name of the device. Specifies the name that users see when they want to wirelessly project to the device.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ DefaultVolume
+
+
+
+
+
+ 45
+ Specifies the default volume value for a new session.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.15063
+ 1.0
+
+
+ [0-100]
+
+
+
+
+ ScreenTimeout
+
+
+
+
+
+ 5
+ Specifies the number of minutes until the Hub screen turns off.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.15063
+ 1.0
+
+
+
+ 0
+ Never time out
+
+
+ 1
+ 1 minute
+
+
+ 2
+ 2 minutes
+
+
+ 3
+ 3 minutes
+
+
+ 5
+ 5 minutes
+
+
+ 10
+ 10 minutes
+
+
+ 15
+ 15 minutes
+
+
+ 30
+ 30 minutes
+
+
+ 60
+ 1 hour
+
+
+ 120
+ 2 hours
+
+
+ 240
+ 4 hours
+
+
+
+
+
+ SleepMode
+
+
+
+
+
+ 0
+ Specifies the type of sleep mode for the Surface Hub.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.15063
+ 1.0
+
+
+
+ 0
+ Connected Standby
+
+
+ 1
+ Hibernate
+
+
+
+
+
+ SessionTimeout
+
+
+
+
+
+ 1
+ Specifies the number of minutes until the session times out.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.15063
+ 1.0
+
+
+
+ 0
+ Never time out
+
+
+ 1
+ 1 minute
+
+
+ 2
+ 2 minutes
+
+
+ 3
+ 3 minutes
+
+
+ 5
+ 5 minutes
+
+
+ 10
+ 10 minutes
+
+
+ 15
+ 15 minutes
+
+
+ 30
+ 30 minutes
+
+
+ 60
+ 1 hour
+
+
+ 120
+ 2 hours
+
+
+ 240
+ 4 hours
+
+
+
+
+
+ SleepTimeout
+
+
+
+
+
+ 5
+ Specifies the number of minutes until the Hub enters sleep mode.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.15063
+ 1.0
+
+
+
+ 0
+ Never time out
+
+
+ 1
+ 1 minute
+
+
+ 2
+ 2 minutes
+
+
+ 3
+ 3 minutes
+
+
+ 5
+ 5 minutes
+
+
+ 10
+ 10 minutes
+
+
+ 15
+ 15 minutes
+
+
+ 30
+ 30 minutes
+
+
+ 60
+ 1 hour
+
+
+ 120
+ 2 hours
+
+
+ 240
+ 4 hours
+
+
+
+
+
+ AllowSessionResume
+
+
+
+
+
+ true
+ Specifies whether to allow the ability to resume a session when the session times out. If this setting is true, the "Resume Session" feature will be available on the welcome screen when the screen is idle. If false, once the screen idles, the session will be automatically cleaned up as if the “End Session" feature was initiated.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.15063
+ 1.0
+
+
+
+ false
+ Disabled
+
+
+ true
+ Enabled
+
+
+
+
+
+ AllowAutoProxyAuth
+
+
+
+
+
+ true
+ Specifies whether to use the device account for proxy authentication. If this setting is true, the device account will be used for proxy authentication. If false, a separate account will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.15063
+ 1.0
+
+
+
+ false
+ Disabled
+
+
+ true
+ Enabled
+
+
+
+
+
+ DisableSigninSuggestions
+
+
+
+
+
+ false
+ Specifies whether to disable auto-populating of the sign-in dialog with invitees from scheduled meetings. If this setting is true, the sign-in dialog will not be populated. If false, the dialog will auto-populate.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.15063
+ 1.0
+
+
+
+ false
+ Dialog will auto-populate.
+
+
+ true
+ Sign-in dialog will not be populated.
+
+
+
+
+
+ SurfaceHubMeetingMode
+
+
+
+
+
+
+ 0
+ Teams mode
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.15063, 10.0.14393.969
+ 1.0
+
+
+ [0-2]
+
+
+
+
+ VtcAppPackageId
+
+
+
+
+
+
+ App name
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.15063, 10.0.14393.969
+ 1.0
+
+
+
+
+
+
+ DoNotShowMyMeetingsAndFiles
+
+
+
+
+
+ false
+ Specifies whether to disable the "My meetings and files" feature in the Start menu, which shows the signed-in user's meetings and files from Office 365. If this setting is true, the “My meetings and files” feature will not be shown. When false, the “My meetings and files” feature will be shown.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.15063
+ 1.0
+
+
+
+ true
+ "My meetings and files" feature will not be shown.
+
+
+ false
+ The "My meetings and files" feature will be shown.
+
+
+
+
+
+ ProxyServers
+
+
+
+
+
+
+ The list of known proxy servers to provide.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Management
+
+
+
+
+ Not a supported scenario
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.15063, 10.0.14393.969
+ 1.0
+
+
+
+ GroupName
+
+
+
+
+
+ The name of the domain admin group to add to the administrators group on the device.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ GroupSid
+
+
+
+
+
+ The sid of the domain admin group to add to the administrators group on the device.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MOMAgent
+
+
+
+
+ Node for the Microsoft Operations Management Suite.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WorkspaceID
+
+
+
+
+
+ GUID identifying the Microsoft Operations Management Suite workspace ID to collect the data. Set this to an empty string to disable the MOM agent.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WorkspaceKey
+
+
+
+
+
+ Primary key for authenticating with workspace. Will always return an empty string.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Dot3
+
+
+
+
+ Parent node
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 10.0.17134, 10.0.16299.64
+ 1.0
+
+
+
+
+
+ LanProfile
+
+
+
+
+
+ Used to specify credentials to authenticate device to the network.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ EapUserData
+
+
+
+
+
+ Used to specify credentials to authenticate device to the network.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
```
-
-
-
-
-
-
-
-
+## Related articles
+[SurfaceHub configuration service provider reference](surfacehub-csp.md)