SurfaceHub CSP
Important
This CSP contains some settings that are under development and only applicable for Windows Insider Preview builds. These settings are subject to change and may have dependencies on other features or services in preview.
The SurfaceHub configuration service provider (CSP) is used to configure Microsoft Surface Hub settings.
The following list shows the SurfaceHub configuration service provider nodes:
- ./Vendor/MSFT/SurfaceHub
DeviceAccount
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount
Node for setting device account information. A device account is a Microsoft Exchange account that's 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 Microsoft Entra ID: 1. Set the UserPrincipalName (for Microsoft Entra ID). 2. Set a valid Password. 3. Execute ValidateAndCommit to validate the specified username and password combination against Microsoft Entra ID. 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:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
| Case Sensitive | True |
Example:
<SyncML xmlns="SYNCML:SYNCML1.2">
<SyncBody>
<Replace>
<CmdID>1</CmdID>
<Item>
<Target>
<LocURI>./Vendor/MSFT/SurfaceHub/DeviceAccount/UserPrincipalName</LocURI>
</Target>
<Meta>
<Format xmlns="syncml:metinf">chr</Format>
</Meta>
<Data>[email protected]</Data>
</Item>
</Replace>
<Replace>
<CmdID>2</CmdID>
<Item>
<Target>
<LocURI>./Vendor/MSFT/SurfaceHub/DeviceAccount/Password</LocURI>
</Target>
<Meta>
<Format xmlns="syncml:metinf">chr</Format>
</Meta>
<Data>password</Data>
</Item>
</Replace>
<Exec>
<CmdID>3</CmdID>
<Item>
<Target>
<LocURI>./Vendor/MSFT/SurfaceHub/DeviceAccount/ValidateAndCommit</LocURI>
</Target>
</Item>
</Exec>
<Get>
<CmdID>4</CmdID>
<Item>
<Target>
<LocURI>./Vendor/MSFT/SurfaceHub/DeviceAccount/ErrorContext</LocURI>
</Target>
</Item>
</Get>
<Final/>
</SyncBody>
</SyncML>
DeviceAccount/CalendarSyncEnabled
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount/CalendarSyncEnabled
Specifies whether calendar sync and other Exchange server services is enabled.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bool |
| Access Type | Get, Replace |
Allowed values:
| Value | Description |
|---|---|
| false | Disabled. |
| true | Enabled. |
DeviceAccount/DomainName
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount/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.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Get, Replace |
DeviceAccount/Email
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount/Email
Email address of the device account.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Get, Replace |
DeviceAccount/ErrorContext
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount/ErrorContext
If there is an error calling ValidateAndCommit, there will be additional context for that error in this node.
Possible error values:
| ErrorContext value | Stage where error occurred | Description and suggestions |
|---|---|---|
| 1 | Unknown | |
| 2 | Populating account | Unable to retrieve account details using the username and password you provided. For Microsoft Entra accounts, ensure that UserPrincipalName and Password are valid. For AD accounts, ensure that DomainName, UserName, and Password are valid. Ensure that the specified account has an Exchange server mailbox. |
| 3 | Populating Exchange server address | Unable to auto-discover your Exchange server address. Try to manually specify the Exchange server address using the ExchangeServer field. |
| 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. |
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get |
DeviceAccount/ExchangeModernAuthEnabled
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 2004 with KB4598291 [10.0.19041.789] and later ✅ Windows 10, version 20H2 with KB4598291 [10.0.19042.789] and later ✅ Windows Insider Preview |
./Vendor/MSFT/SurfaceHub/DeviceAccount/ExchangeModernAuthEnabled
Specifies whether Device Account calendar sync will attempt to use token-based Modern Authentication to connect to the Exchange Server.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bool |
| Access Type | Get, Replace |
| Default Value | True |
Allowed values:
| Value | Description |
|---|---|
| False | Disabled. |
| True (Default) | Enabled. |
DeviceAccount/ExchangeServer
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./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/PasswordRotationEnabled
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount/PasswordRotationEnabled
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 Microsoft Entra ID).
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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/DeviceAccount/UserPrincipalName
User principal name (UPN) of the device account. To use a device account from Microsoft Entra ID 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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 with KB4048955 [10.0.16299.64] and later ✅ Windows 10, version 1803 [10.0.17134] and later |
./Vendor/MSFT/SurfaceHub/Dot3
Parent node.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
Dot3/EapUserData
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 with KB4048955 [10.0.16299.64] and later ✅ Windows 10, version 1803 [10.0.17134] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1709 with KB4048955 [10.0.16299.64] and later ✅ Windows 10, version 1803 [10.0.17134] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/InBoxApps
Node for the in-box app settings.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
InBoxApps/Connect
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1703 [10.0.15063] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1703 [10.0.15063] and later |
./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 Set up your domain and users.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Get, Replace |
InBoxApps/Teams
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 2004 with KB4566782 [10.0.19041.450] and later ✅ Windows 10, version 20H2 [10.0.19042] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 2004 with KB4566782 [10.0.19041.450] and later ✅ Windows 10, version 20H2 [10.0.19042] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/InBoxApps/Welcome
Node for the welcome screen.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
InBoxApps/Welcome/AutoWakeScreen
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./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're 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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/InBoxApps/Welcome/MeetingInfoOption
Meeting information displayed on the welcome screen.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get, Replace |
Allowed values:
| Value | Description |
|---|---|
| 0 | Organizer and time only. |
| 1 | Organizer, time, and subject. Subject is hidden in private meetings. |
InBoxApps/Whiteboard
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1903 with KB4522355 [10.0.18362.449] and later ✅ Windows 10, version 1909 [10.0.18363] and later |
./Vendor/MSFT/SurfaceHub/InBoxApps/Whiteboard
This node controls policies specific to the Whiteboard App on Surface Hub.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
InBoxApps/Whiteboard/SharingDisabled
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1903 with KB4522355 [10.0.18362.449] and later ✅ Windows 10, version 1909 [10.0.18363] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1903 with KB4522355 [10.0.18362.449] and later ✅ Windows 10, version 1909 [10.0.18363] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1903 with KB4522355 [10.0.18362.449] and later ✅ Windows 10, version 1909 [10.0.18363] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/InBoxApps/WirelessProjection
Node for the wireless projector app settings.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
InBoxApps/WirelessProjection/Channel
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./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 |
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).
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get, Replace |
| Default Value | 255 |
InBoxApps/WirelessProjection/Enabled
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/InBoxApps/WirelessProjection/Enabled
Enables wireless projection to the device.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bool |
| Access Type | Get, Replace |
Allowed values:
| Value | Description |
|---|---|
| false | Disabled. |
| true | Enabled. |
InBoxApps/WirelessProjection/PINRequired
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/InBoxApps/WirelessProjection/PINRequired
Users must enter a PIN to wirelessly project to the device.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | bool |
| Access Type | Get, Replace |
Allowed values:
| Value | Description |
|---|---|
| false | Pin not required. |
| true | Pin required. |
MaintenanceHoursSimple
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/MaintenanceHoursSimple
Node for maintenance schedule.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
MaintenanceHoursSimple/Hours
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/MaintenanceHoursSimple/Hours
Node for maintenance schedule.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
MaintenanceHoursSimple/Hours/Duration
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/MaintenanceHoursSimple/Hours/Duration
Specifies the duration of maintenance window in minutes. For example, to set a 3-hour duration, set this value to 180.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get, Replace |
| Allowed Values | Range: [0-1439] |
MaintenanceHoursSimple/Hours/StartTime
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/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.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get, Replace |
| Allowed Values | Range: [0-1439] |
Management
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1607 with KB4015438 [10.0.14393.969] and later ✅ Windows 10, version 1703 [10.0.15063] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1607 with KB4015438 [10.0.14393.969] and later ✅ Windows 10, version 1703 [10.0.15063] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1607 with KB4015438 [10.0.14393.969] and later ✅ Windows 10, version 1703 [10.0.15063] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./Vendor/MSFT/SurfaceHub/MOMAgent
Node for the Microsoft Operations Management Suite.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
MOMAgent/WorkspaceID
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./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 |
MOMAgentGovtCloud
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 22H2 with KB5036979 [10.0.19045.4355] and later |
./Vendor/MSFT/SurfaceHub/MOMAgentGovtCloud
Description framework properties:
| Property name | Property value |
|---|---|
| Format | node |
| Access Type | Get |
MOMAgentGovtCloud/AzureCloudIndexGovtCloud
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 22H2 with KB5036979 [10.0.19045.4355] and later |
./Vendor/MSFT/SurfaceHub/MOMAgentGovtCloud/AzureCloudIndexGovtCloud
Enum value for Azure Clouds supported for OMS tracking in SurfaceHub.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get, Replace |
| Default Value | 0 |
MOMAgentGovtCloud/WorkspaceIDGovtCloud
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 22H2 with KB5036979 [10.0.19045.4355] and later |
./Vendor/MSFT/SurfaceHub/MOMAgentGovtCloud/WorkspaceIDGovtCloud
GUID identifying the Microsoft Operations Management Suite workspace ID to collect the data for Govt Clouds. 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 |
MOMAgentGovtCloud/WorkspaceKeyGovtCloud
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 22H2 with KB5036979 [10.0.19045.4355] and later |
./Vendor/MSFT/SurfaceHub/MOMAgentGovtCloud/WorkspaceKeyGovtCloud
Primary key for authenticating with workspace for Govt Clouds. 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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1703 [10.0.15063] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1703 [10.0.15063] and later |
./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/DefaultAutomaticFraming
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 20H2 [10.0.19042] and later |
./Vendor/MSFT/SurfaceHub/Properties/DefaultAutomaticFraming
Specifies whether the Surface Hub 2 Smart Camera feature to automatically zoom and keep users centered in the video is enabled.
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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1703 [10.0.15063] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1703 [10.0.15063] and later |
./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 won't 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 won't be populated. |
Properties/DoNotShowMyMeetingsAndFiles
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1703 [10.0.15063] and later |
./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 won't 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 won't be shown. |
| false (Default) | The "My meetings and files" feature will be shown. |
Properties/FriendlyName
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1511 [10.0.10586] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1703 [10.0.15063] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1703 [10.0.15063] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1703 [10.0.15063] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1703 [10.0.15063] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1607 with KB4015438 [10.0.14393.969] and later ✅ Windows 10, version 1703 [10.0.15063] and later |
./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 |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 1607 with KB4015438 [10.0.14393.969] and later ✅ Windows 10, version 1703 [10.0.15063] and later |
./Vendor/MSFT/SurfaceHub/Properties/VtcAppPackageId
App name.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | chr (string) |
| Access Type | Delete, Get, Replace |
UpdateBootManager
| Scope | Editions | Applicable OS |
|---|---|---|
| ✅ Device ❌ User |
✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC |
✅ Windows 10, version 22H2 [10.0.19045] and later |
./Vendor/MSFT/SurfaceHub/UpdateBootManager
Enables new boot manager usage.
Description framework properties:
| Property name | Property value |
|---|---|
| Format | int |
| Access Type | Get, Replace |
| Default Value | 0 |
Allowed values:
| Value | Description |
|---|---|
| 0 (Default) | Disable new boot manager. |
| 320 | Enable new boot manager. |