deepblue/windows-itpro-docs
1
0
Fork 0
mirror of https://github.com/MicrosoftDocs/windows-itpro-docs.git synced 2025-05-12 13:27:23 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

add remoteassistance csp

Browse Source
This commit is contained in:
Aaron Czechowski 2022-12-20 12:52:47 -08:00
parent e8617233dd
commit 2b38bb1e0f
1 changed files with 225 additions and 185 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

410
windows/client-management/mdm/policy-csp-remoteassistance.md
View File

@ -1,289 +1,329 @@
---
title: Policy CSP - RemoteAssistance
description: Learn how the Policy CSP - RemoteAssistance setting allows you to specify a custom message to display.
title: RemoteAssistance Policy CSP
description: Learn more about the RemoteAssistance Area in Policy CSP
author: vinaypamnani-msft
manager: aaroncz
ms.author: vinpa
ms.topic: article
ms.date: 12/20/2022
ms.localizationpriority: medium
ms.prod: windows-client
ms.technology: itpro-manage
author: vinaypamnani-msft
ms.localizationpriority: medium
ms.date: 09/27/2019
ms.reviewer:
manager: aaroncz
ms.topic: reference
---
<!-- Auto-Generated CSP Document -->
<!-- RemoteAssistance-Begin -->
# Policy CSP - RemoteAssistance
<hr/>
<!--Policies-->
## RemoteAssistance policies
<dl>
<dd>
<a href="#remoteassistance-customizewarningmessages">RemoteAssistance/CustomizeWarningMessages</a>
</dd>
<dd>
<a href="#remoteassistance-sessionlogging">RemoteAssistance/SessionLogging</a>
</dd>
<dd>
<a href="#remoteassistance-solicitedremoteassistance">RemoteAssistance/SolicitedRemoteAssistance</a>
</dd>
<dd>
<a href="#remoteassistance-unsolicitedremoteassistance">RemoteAssistance/UnsolicitedRemoteAssistance</a>
</dd>
</dl>
> [!TIP]
> These are ADMX-backed policies and require a special SyncML format to enable or disable. For details, see [Understanding ADMX-backed policies](../understanding-admx-backed-policies.md).
> Some of these are ADMX-backed policies and require a special SyncML format to enable or disable. For details, see [Understanding ADMX-backed policies](./understanding-admx-backed-policies.md).
>
> You must specify the data type in the SyncML as &lt;Format&gt;chr&lt;/Format&gt;. For an example SyncML, refer to [Enabling a policy](../understanding-admx-backed-policies.md#enabling-a-policy).
> You must specify the data type in the SyncML as &lt;Format&gt;chr&lt;/Format&gt;. For an example SyncML, refer to [Enabling a policy](./understanding-admx-backed-policies.md#enabling-a-policy).
>
> The payload of the SyncML must be XML-encoded; for this XML encoding, there are a variety of online encoders that you can use. To avoid encoding the payload, you can use CDATA if your MDM supports it. For more information, see [CDATA Sections](http://www.w3.org/TR/REC-xml/#sec-cdata-sect).
<hr/>
<!-- RemoteAssistance-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- RemoteAssistance-Editable-End -->
<!--Policy-->
<a href="" id="remoteassistance-customizewarningmessages"></a>**RemoteAssistance/CustomizeWarningMessages**
<!-- CustomizeWarningMessages-Begin -->
## CustomizeWarningMessages
<!--SupportedSKUs-->
<!-- CustomizeWarningMessages-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :x: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
<!-- CustomizeWarningMessages-Applicability-End -->
|Edition|Windows 10|Windows 11|
|--- |--- |--- |
|Home|No|No|
|Pro|Yes|Yes|
|Windows SE|No|Yes|
|Business|Yes|Yes|
|Enterprise|Yes|Yes|
|Education|Yes|Yes|
<!-- CustomizeWarningMessages-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/Policy/Config/RemoteAssistance/CustomizeWarningMessages
```
<!-- CustomizeWarningMessages-OmaUri-End -->
<!--/SupportedSKUs-->
<hr/>
<!--Scope-->
[Scope](./policy-configuration-service-provider.md#policy-scope):
> [!div class = "checklist"]
> * Device
<hr/>
<!--/Scope-->
<!--Description-->
<!-- CustomizeWarningMessages-Description-Begin -->
<!-- Description-Source-ADMX -->
This policy setting lets you customize warning messages.
The "Display warning message before sharing control" policy setting allows you to specify a custom message, to display before users share control of their computers.
The "Display warning message before sharing control" policy setting allows you to specify a custom message to display before a user shares control of his or her computer.
The "Display warning message before connecting" policy setting allows you to specify a custom message, to display before users allow a connection to their computers.
The "Display warning message before connecting" policy setting allows you to specify a custom message to display before a user allows a connection to his or her computer.
If you enable this policy setting, the warning message you specify overrides the default message that is seen by the novice.
If you disable this policy setting, the user sees the default warning message.
If you don't configure this policy setting, the user sees the default warning message.
If you do not configure this policy setting, the user sees the default warning message.
<!-- CustomizeWarningMessages-Description-End -->
<!--/Description-->
<!-- CustomizeWarningMessages-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- CustomizeWarningMessages-Editable-End -->
<!--ADMXBacked-->
ADMX Info:
- GP Friendly name: *Customize warning messages*
- GP name: *RA_Options*
- GP path: *System/Remote Assistance*
- GP ADMX file name: *remoteassistance.admx*
<!-- CustomizeWarningMessages-DFProperties-Begin -->
**Description framework properties**:
<!--/ADMXBacked-->
<!--/Policy-->
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Add, Delete, Get, Replace |
<!-- CustomizeWarningMessages-DFProperties-End -->
<hr/>
<!-- CustomizeWarningMessages-AdmxBacked-Begin -->
> [!TIP]
> This is an ADMX-backed policy and requires SyncML format for configuration. For details, see [Understanding ADMX-backed policies](./understanding-admx-backed-policies.md).
<!--Policy-->
<a href="" id="remoteassistance-sessionlogging"></a>**RemoteAssistance/SessionLogging**
**ADMX mapping**:
<!--SupportedSKUs-->
| Name | Value |
|:--|:--|
| Name | RA_Options |
| Friendly Name | Customize warning messages |
| Location | Computer Configuration |
| Path | System > Remote Assistance |
| Registry Key Name | Software\policies\Microsoft\Windows NT\Terminal Services |
| Registry Value Name | UseCustomMessages |
| ADMX File Name | RemoteAssistance.admx |
<!-- CustomizeWarningMessages-AdmxBacked-End -->
|Edition|Windows 10|Windows 11|
|--- |--- |--- |
|Home|No|No|
|Pro|Yes|Yes|
|Windows SE|No|Yes|
|Business|Yes|Yes|
|Enterprise|Yes|Yes|
|Education|Yes|Yes|
<!-- CustomizeWarningMessages-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- CustomizeWarningMessages-Examples-End -->
<!--/SupportedSKUs-->
<hr/>
<!-- CustomizeWarningMessages-End -->
<!--Scope-->
[Scope](./policy-configuration-service-provider.md#policy-scope):
<!-- SessionLogging-Begin -->
## SessionLogging
> [!div class = "checklist"]
> * Device
<!-- SessionLogging-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :x: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
<!-- SessionLogging-Applicability-End -->
<hr/>
<!-- SessionLogging-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/Policy/Config/RemoteAssistance/SessionLogging
```
<!-- SessionLogging-OmaUri-End -->
<!--/Scope-->
<!--Description-->
<!-- SessionLogging-Description-Begin -->
<!-- Description-Source-ADMX -->
This policy setting allows you to turn logging on or off. Log files are located in the user's Documents folder under Remote Assistance.
If you enable this policy setting, log files are generated.
If you disable this policy setting, log files aren't generated.
If you disable this policy setting, log files are not generated.
If you don't configure this setting, application-based settings are used.
If you do not configure this setting, application-based settings are used.
<!-- SessionLogging-Description-End -->
<!--/Description-->
<!-- SessionLogging-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- SessionLogging-Editable-End -->
<!--ADMXBacked-->
ADMX Info:
- GP Friendly name: *Turn on session logging*
- GP name: *RA_Logging*
- GP path: *System/Remote Assistance*
- GP ADMX file name: *remoteassistance.admx*
<!-- SessionLogging-DFProperties-Begin -->
**Description framework properties**:
<!--/ADMXBacked-->
<!--/Policy-->
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Add, Delete, Get, Replace |
<!-- SessionLogging-DFProperties-End -->
<hr/>
<!-- SessionLogging-AdmxBacked-Begin -->
> [!TIP]
> This is an ADMX-backed policy and requires SyncML format for configuration. For details, see [Understanding ADMX-backed policies](./understanding-admx-backed-policies.md).
<!--Policy-->
<a href="" id="remoteassistance-solicitedremoteassistance"></a>**RemoteAssistance/SolicitedRemoteAssistance**
**ADMX mapping**:
<!--SupportedSKUs-->
| Name | Value |
|:--|:--|
| Name | RA_Logging |
| Friendly Name | Turn on session logging |
| Location | Computer Configuration |
| Path | System > Remote Assistance |
| Registry Key Name | Software\policies\Microsoft\Windows NT\Terminal Services |
| Registry Value Name | LoggingEnabled |
| ADMX File Name | RemoteAssistance.admx |
<!-- SessionLogging-AdmxBacked-End -->
|Edition|Windows 10|Windows 11|
|--- |--- |--- |
|Home|No|No|
|Pro|Yes|Yes|
|Windows SE|No|Yes|
|Business|Yes|Yes|
|Enterprise|Yes|Yes|
|Education|Yes|Yes|
<!-- SessionLogging-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- SessionLogging-Examples-End -->
<!--/SupportedSKUs-->
<hr/>
<!-- SessionLogging-End -->
<!--Scope-->
[Scope](./policy-configuration-service-provider.md#policy-scope):
<!-- SolicitedRemoteAssistance-Begin -->
## SolicitedRemoteAssistance
> [!div class = "checklist"]
> * Device
<!-- SolicitedRemoteAssistance-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :x: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
<!-- SolicitedRemoteAssistance-Applicability-End -->
<hr/>
<!-- SolicitedRemoteAssistance-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/Policy/Config/RemoteAssistance/SolicitedRemoteAssistance
```
<!-- SolicitedRemoteAssistance-OmaUri-End -->
<!--/Scope-->
<!--Description-->
<!-- SolicitedRemoteAssistance-Description-Begin -->
<!-- Description-Source-ADMX -->
This policy setting allows you to turn on or turn off Solicited (Ask for) Remote Assistance on this computer.
If you enable this policy setting, users on this computer can use email or file transfer to ask someone for help. Also, users can use instant messaging programs to allow connections to this computer, and you can configure more Remote Assistance settings.
If you enable this policy setting, users on this computer can use email or file transfer to ask someone for help. Also, users can use instant messaging programs to allow connections to this computer, and you can configure additional Remote Assistance settings.
If you disable this policy setting, users on this computer can't use email or file transfer to ask someone for help. Also, users can't use instant messaging programs to allow connections to this computer.
If you disable this policy setting, users on this computer cannot use email or file transfer to ask someone for help. Also, users cannot use instant messaging programs to allow connections to this computer.
If you don't configure this policy setting, users can turn on or turn off Solicited (Ask for) Remote Assistance themselves in System Properties in Control Panel. Users can also configure Remote Assistance settings.
If you do not configure this policy setting, users can turn on or turn off Solicited (Ask for) Remote Assistance themselves in System Properties in Control Panel. Users can also configure Remote Assistance settings.
If you enable this policy setting, you have two ways to allow helpers to provide Remote Assistance: "Allow helpers to only view the computer" or "Allow helpers to remotely control the computer."
The "Maximum ticket time" policy setting sets a limit on the amount of time that a Remote Assistance invitation created by using email or file transfer can remain open.
The "Select the method for sending email invitations" setting specifies which email standard to use, to send Remote Assistance invitations. Depending on your email program, you can use either the Mailto standard (the invitation recipient connects through an Internet link) or the SMAPI (Simple MAPI) standard (the invitation is attached to your email message). This policy setting isn't available in Windows Vista, since SMAPI is the only method supported.
The "Select the method for sending email invitations" setting specifies which email standard to use to send Remote Assistance invitations. Depending on your email program, you can use either the Mailto standard (the invitation recipient connects through an Internet link) or the SMAPI (Simple MAPI) standard (the invitation is attached to your email message). This policy setting is not available in Windows Vista since SMAPI is the only method supported.
If you enable this policy setting, you should also enable appropriate firewall exceptions to allow Remote Assistance communications.
If you enable this policy setting you should also enable appropriate firewall exceptions to allow Remote Assistance communications.
<!-- SolicitedRemoteAssistance-Description-End -->
<!--/Description-->
<!-- SolicitedRemoteAssistance-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- SolicitedRemoteAssistance-Editable-End -->
<!--ADMXBacked-->
ADMX Info:
- GP Friendly name: *Configure Solicited Remote Assistance*
- GP name: *RA_Solicit*
- GP path: *System/Remote Assistance*
- GP ADMX file name: *remoteassistance.admx*
<!-- SolicitedRemoteAssistance-DFProperties-Begin -->
**Description framework properties**:
<!--/ADMXBacked-->
<!--/Policy-->
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Add, Delete, Get, Replace |
<!-- SolicitedRemoteAssistance-DFProperties-End -->
<hr/>
<!-- SolicitedRemoteAssistance-AdmxBacked-Begin -->
> [!TIP]
> This is an ADMX-backed policy and requires SyncML format for configuration. For details, see [Understanding ADMX-backed policies](./understanding-admx-backed-policies.md).
<!--Policy-->
<a href="" id="remoteassistance-unsolicitedremoteassistance"></a>**RemoteAssistance/UnsolicitedRemoteAssistance**
**ADMX mapping**:
<!--SupportedSKUs-->
| Name | Value |
|:--|:--|
| Name | RA_Solicit |
| Friendly Name | Configure Solicited Remote Assistance |
| Location | Computer Configuration |
| Path | System > Remote Assistance |
| Registry Key Name | Software\policies\Microsoft\Windows NT\Terminal Services |
| Registry Value Name | fAllowToGetHelp |
| ADMX File Name | RemoteAssistance.admx |
<!-- SolicitedRemoteAssistance-AdmxBacked-End -->
|Edition|Windows 10|Windows 11|
|--- |--- |--- |
|Home|No|No|
|Pro|Yes|Yes|
|Windows SE|No|Yes|
|Business|Yes|Yes|
|Enterprise|Yes|Yes|
|Education|Yes|Yes|
<!-- SolicitedRemoteAssistance-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- SolicitedRemoteAssistance-Examples-End -->
<!--/SupportedSKUs-->
<hr/>
<!-- SolicitedRemoteAssistance-End -->
<!--Scope-->
[Scope](./policy-configuration-service-provider.md#policy-scope):
<!-- UnsolicitedRemoteAssistance-Begin -->
## UnsolicitedRemoteAssistance
> [!div class = "checklist"]
> * Device
<!-- UnsolicitedRemoteAssistance-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :x: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
<!-- UnsolicitedRemoteAssistance-Applicability-End -->
<hr/>
<!-- UnsolicitedRemoteAssistance-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/Policy/Config/RemoteAssistance/UnsolicitedRemoteAssistance
```
<!-- UnsolicitedRemoteAssistance-OmaUri-End -->
<!--/Scope-->
<!--Description-->
<!-- UnsolicitedRemoteAssistance-Description-Begin -->
<!-- Description-Source-ADMX -->
This policy setting allows you to turn on or turn off Offer (Unsolicited) Remote Assistance on this computer.
If you enable this policy setting, users on this computer can get help from their corporate technical support staff using Offer (Unsolicited) Remote Assistance.
If you disable this policy setting, users on this computer can't get help from their corporate technical support staff using Offer (Unsolicited) Remote Assistance.
If you disable this policy setting, users on this computer cannot get help from their corporate technical support staff using Offer (Unsolicited) Remote Assistance.
If you don't configure this policy setting, users on this computer can't get help from their corporate technical support staff using Offer (Unsolicited) Remote Assistance.
If you do not configure this policy setting, users on this computer cannot get help from their corporate technical support staff using Offer (Unsolicited) Remote Assistance.
If you enable this policy setting, you have two ways to allow helpers to provide Remote Assistance: "Allow helpers to only view the computer" or "Allow helpers to remotely control the computer." When you configure this policy setting, you also specify the list of users or user groups that are allowed to offer remote assistance.
To configure the list of helpers, click "Show." In the window that opens, you can enter the names of the helpers. Add each user or group one by one. When you enter the name of the helper user or user groups, use the following format:
`<Domain Name>\<User Name>` or
`<Domain Name>`\\`<User Name>` or
`<Domain Name>\<Group Name>`
`<Domain Name>`\\`<Group Name>`
If you enable this policy setting, you should also enable firewall exceptions to allow Remote Assistance communications. The firewall exceptions required for Offer (Unsolicited) Remote Assistance depend on the version of Windows you're running.
If you enable this policy setting, you should also enable firewall exceptions to allow Remote Assistance communications. The firewall exceptions required for Offer (Unsolicited) Remote Assistance depend on the version of Windows you are running.
Windows Vista and later
Enable the Remote Assistance exception for the domain profile. The exception must contain:
- Port 135:TCP
- %WINDIR%\System32\msra.exe
- %WINDIR%\System32\raserver.exe
Port 135:TCP
%WINDIR%\System32\msra.exe
%WINDIR%\System32\raserver.exe
Windows XP with Service Pack 2 (SP2) and Windows XP Professional x64 Edition with Service Pack 1 (SP1)
- Port 135:TCP
- %WINDIR%\PCHealth\HelpCtr\Binaries\Helpsvc.exe
- %WINDIR%\PCHealth\HelpCtr\Binaries\Helpctr.exe
- %WINDIR%\System32\Sessmgr.exe
Port 135:TCP
%WINDIR%\PCHealth\HelpCtr\Binaries\Helpsvc.exe
%WINDIR%\PCHealth\HelpCtr\Binaries\Helpctr.exe
%WINDIR%\System32\Sessmgr.exe
For computers running Windows Server 2003 with Service Pack 1 (SP1)
- Port 135:TCP
- %WINDIR%\PCHealth\HelpCtr\Binaries\Helpsvc.exe
- %WINDIR%\PCHealth\HelpCtr\Binaries\Helpctr.exe
- Allow Remote Desktop Exception
Port 135:TCP
%WINDIR%\PCHealth\HelpCtr\Binaries\Helpsvc.exe
%WINDIR%\PCHealth\HelpCtr\Binaries\Helpctr.exe
Allow Remote Desktop Exception
<!-- UnsolicitedRemoteAssistance-Description-End -->
<!--/Description-->
<!-- UnsolicitedRemoteAssistance-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- UnsolicitedRemoteAssistance-Editable-End -->
<!--ADMXBacked-->
ADMX Info:
- GP Friendly name: *Configure Offer Remote Assistance*
- GP name: *RA_Unsolicit*
- GP path: *System/Remote Assistance*
- GP ADMX file name: *remoteassistance.admx*
<!-- UnsolicitedRemoteAssistance-DFProperties-Begin -->
**Description framework properties**:
<!--/ADMXBacked-->
<!--/Policy-->
<hr/>
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Add, Delete, Get, Replace |
<!-- UnsolicitedRemoteAssistance-DFProperties-End -->
<!--/Policies-->
<!-- UnsolicitedRemoteAssistance-AdmxBacked-Begin -->
> [!TIP]
> This is an ADMX-backed policy and requires SyncML format for configuration. For details, see [Understanding ADMX-backed policies](./understanding-admx-backed-policies.md).
## Related topics
**ADMX mapping**:
[Policy configuration service provider](policy-configuration-service-provider.md)
| Name | Value |
|:--|:--|
| Name | RA_Unsolicit |
| Friendly Name | Configure Offer Remote Assistance |
| Location | Computer Configuration |
| Path | System > Remote Assistance |
| Registry Key Name | Software\policies\Microsoft\Windows NT\Terminal Services |
| Registry Value Name | fAllowUnsolicited |
| ADMX File Name | RemoteAssistance.admx |
<!-- UnsolicitedRemoteAssistance-AdmxBacked-End -->
<!-- UnsolicitedRemoteAssistance-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- UnsolicitedRemoteAssistance-Examples-End -->
<!-- UnsolicitedRemoteAssistance-End -->
<!-- RemoteAssistance-CspMoreInfo-Begin -->
<!-- Add any additional information about this CSP here. Anything outside this section will get overwritten. -->
<!-- RemoteAssistance-CspMoreInfo-End -->
<!-- RemoteAssistance-End -->
## Related articles
[Policy configuration service provider](policy-configuration-service-provider.md)