diff --git a/windows/client-management/mdm/policy-csp-remoteshell.md b/windows/client-management/mdm/policy-csp-remoteshell.md index dcb0d50872..857bea7950 100644 --- a/windows/client-management/mdm/policy-csp-remoteshell.md +++ b/windows/client-management/mdm/policy-csp-remoteshell.md @@ -1,131 +1,109 @@ --- -title: Policy CSP - RemoteShell -description: Learn details about the Policy CSP - RemoteShell setting so that you can configure access to remote shells. +title: RemoteShell Policy CSP +description: Learn more about the RemoteShell 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 --- + + + # Policy CSP - RemoteShell -
- - -## RemoteShell policies - -
-
- RemoteShell/AllowRemoteShellAccess -
-
- RemoteShell/MaxConcurrentUsers -
-
- RemoteShell/SpecifyIdleTimeout -
-
- RemoteShell/SpecifyMaxMemory -
-
- RemoteShell/SpecifyMaxProcesses -
-
- RemoteShell/SpecifyMaxRemoteShells -
-
- RemoteShell/SpecifyShellTimeout -
-
- > [!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 <Format>chr</Format>. 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 <Format>chr</Format>. 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). +> 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). -
+ + + - -**RemoteShell/AllowRemoteShellAccess** + +## AllowRemoteShellAccess - + +| 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] and later | + -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|No|No| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| + +```Device +./Device/Vendor/MSFT/Policy/Config/RemoteShell/AllowRemoteShellAccess +``` + - -
- - -[Scope](./policy-configuration-service-provider.md#policy-scope): - -> [!div class = "checklist"] -> * Device - -
- - - + + This policy setting configures access to remote shells. If you enable or do not configure this policy setting, new remote shell connections are accepted by the server. If you set this policy to ‘disabled’, new remote shell connections are rejected by the server. + - + + + - -ADMX Info: -- GP Friendly name: *Allow Remote Shell Access* -- GP name: *AllowRemoteShellAccess* -- GP path: *Windows Components/Windows Remote Shell* -- GP ADMX file name: *WindowsRemoteShell.admx* + +**Description framework properties**: - - +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + -
+ +> [!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). - -**RemoteShell/MaxConcurrentUsers** +**ADMX mapping**: - +| Name | Value | +|:--|:--| +| Name | AllowRemoteShellAccess | +| Friendly Name | Allow Remote Shell Access | +| Location | Computer Configuration | +| Path | Windows Components > Windows Remote Shell | +| Registry Key Name | Software\Policies\Microsoft\Windows\WinRM\Service\WinRS | +| Registry Value Name | AllowRemoteShellAccess | +| ADMX File Name | WindowsRemoteShell.admx | + -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|No|No| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| + + + - -
+ - -[Scope](./policy-configuration-service-provider.md#policy-scope): + +## MaxConcurrentUsers -> [!div class = "checklist"] -> * Device + +| 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] and later | + -
+ +```Device +./Device/Vendor/MSFT/Policy/Config/RemoteShell/MaxConcurrentUsers +``` + - - + + This policy setting configures the maximum number of users able to concurrently perform remote shell operations on the system. The value can be any number from 1 to 100. @@ -133,97 +111,121 @@ The value can be any number from 1 to 100. If you enable this policy setting, the new shell connections are rejected if they exceed the specified limit. If you disable or do not configure this policy setting, the default number is five users. + - + + + - -ADMX Info: -- GP Friendly name: *MaxConcurrentUsers* -- GP name: *MaxConcurrentUsers* -- GP path: *Windows Components/Windows Remote Shell* -- GP ADMX file name: *WindowsRemoteShell.admx* + +**Description framework properties**: - - +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + -
+ +> [!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). - -**RemoteShell/SpecifyIdleTimeout** +**ADMX mapping**: - +| Name | Value | +|:--|:--| +| Name | MaxConcurrentUsers | +| Friendly Name | MaxConcurrentUsers | +| Location | Computer Configuration | +| Path | Windows Components > Windows Remote Shell | +| Registry Key Name | Software\Policies\Microsoft\Windows\WinRM\Service\WinRS | +| ADMX File Name | WindowsRemoteShell.admx | + -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|No|No| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| + + + - -
+ - -[Scope](./policy-configuration-service-provider.md#policy-scope): + +## SpecifyIdleTimeout -> [!div class = "checklist"] -> * Device + +| 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] and later | + -
+ +```Device +./Device/Vendor/MSFT/Policy/Config/RemoteShell/SpecifyIdleTimeout +``` + - - -This policy setting configures the maximum time in milliseconds, and remote shell will stay open without any user activity until it is automatically deleted. + + +This policy setting configures the maximum time in milliseconds remote shell will stay open without any user activity until it is automatically deleted. Any value from 0 to 0x7FFFFFFF can be set. A minimum of 60000 milliseconds (1 minute) is used for smaller values. If you enable this policy setting, the server will wait for the specified amount of time since the last received message from the client before terminating the open shell. If you do not configure or disable this policy setting, the default value of 900000 or 15 min will be used. + - + + + - -ADMX Info: -- GP Friendly name: *Specify idle Timeout* -- GP name: *IdleTimeout* -- GP path: *Windows Components/Windows Remote Shell* -- GP ADMX file name: *WindowsRemoteShell.admx* + +**Description framework properties**: - - +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + -
+ +> [!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). - -**RemoteShell/SpecifyMaxMemory** +**ADMX mapping**: - +| Name | Value | +|:--|:--| +| Name | IdleTimeout | +| Friendly Name | Specify idle Timeout | +| Location | Computer Configuration | +| Path | Windows Components > Windows Remote Shell | +| Registry Key Name | Software\Policies\Microsoft\Windows\WinRM\Service\WinRS | +| ADMX File Name | WindowsRemoteShell.admx | + -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|No|No| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| + + + - -
+ - -[Scope](./policy-configuration-service-provider.md#policy-scope): + +## SpecifyMaxMemory -> [!div class = "checklist"] -> * Device + +| 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] and later | + -
+ +```Device +./Device/Vendor/MSFT/Policy/Config/RemoteShell/SpecifyMaxMemory +``` + - - + + This policy setting configures the maximum total amount of memory in megabytes that can be allocated by any active remote shell and all its child processes. Any value from 0 to 0x7FFFFFFF can be set, where 0 equals unlimited memory, which means the ability of remote operations to allocate memory is only limited by the available virtual memory. @@ -231,161 +233,224 @@ Any value from 0 to 0x7FFFFFFF can be set, where 0 equals unlimited memory, whic If you enable this policy setting, the remote operation is terminated when a new allocation exceeds the specified quota. If you disable or do not configure this policy setting, the value 150 is used by default. + - + + + - -ADMX Info: -- GP Friendly name: *Specify maximum amount of memory in MB per Shell* -- GP name: *MaxMemoryPerShellMB* -- GP path: *Windows Components/Windows Remote Shell* -- GP ADMX file name: *WindowsRemoteShell.admx* + +**Description framework properties**: - - +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + -
+ +> [!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). - -**RemoteShell/SpecifyMaxProcesses** +**ADMX mapping**: - +| Name | Value | +|:--|:--| +| Name | MaxMemoryPerShellMB | +| Friendly Name | Specify maximum amount of memory in MB per Shell | +| Location | Computer Configuration | +| Path | Windows Components > Windows Remote Shell | +| Registry Key Name | Software\Policies\Microsoft\Windows\WinRM\Service\WinRS | +| ADMX File Name | WindowsRemoteShell.admx | + -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|No|No| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| + + + - -
+ - -[Scope](./policy-configuration-service-provider.md#policy-scope): + +## SpecifyMaxProcesses -> [!div class = "checklist"] -> * Device + +| 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] and later | + -
+ +```Device +./Device/Vendor/MSFT/Policy/Config/RemoteShell/SpecifyMaxProcesses +``` + - - + + This policy setting configures the maximum number of processes a remote shell is allowed to launch. If you enable this policy setting, you can specify any number from 0 to 0x7FFFFFFF to set the maximum number of process per shell. Zero (0) means unlimited number of processes. If you disable or do not configure this policy setting, the limit is five processes per shell. + - + + + - -ADMX Info: -- GP Friendly name: *Specify maximum number of processes per Shell* -- GP name: *MaxProcessesPerShell* -- GP path: *Windows Components/Windows Remote Shell* -- GP ADMX file name: *WindowsRemoteShell.admx* + +**Description framework properties**: - - +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + -
+ +> [!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). - -**RemoteShell/SpecifyMaxRemoteShells** +**ADMX mapping**: - +| Name | Value | +|:--|:--| +| Name | MaxProcessesPerShell | +| Friendly Name | Specify maximum number of processes per Shell | +| Location | Computer Configuration | +| Path | Windows Components > Windows Remote Shell | +| Registry Key Name | Software\Policies\Microsoft\Windows\WinRM\Service\WinRS | +| ADMX File Name | WindowsRemoteShell.admx | + -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|No|No| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| + + + - -
+ - -[Scope](./policy-configuration-service-provider.md#policy-scope): + +## SpecifyMaxRemoteShells -> [!div class = "checklist"] -> * Device + +| 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] and later | + -
+ +```Device +./Device/Vendor/MSFT/Policy/Config/RemoteShell/SpecifyMaxRemoteShells +``` + - - -This policy setting configures the maximum number of concurrent shells and any user can remotely open on the same system. + + +This policy setting configures the maximum number of concurrent shells any user can remotely open on the same system. -Any number from 0 to 0x7FFFFFFF can be set, where 0 means unlimited number of shells. +Any number from 0 to 0x7FFFFFFF cand be set, where 0 means unlimited number of shells. If you enable this policy setting, the user cannot open new remote shells if the count exceeds the specified limit. If you disable or do not configure this policy setting, by default the limit is set to two remote shells per user. + - + + + - -ADMX Info: -- GP Friendly name: *Specify maximum number of remote shells per user* -- GP name: *MaxShellsPerUser* -- GP path: *Windows Components/Windows Remote Shell* -- GP ADMX file name: *WindowsRemoteShell.admx* + +**Description framework properties**: - - +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + -
+ +> [!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). - -**RemoteShell/SpecifyShellTimeout** +**ADMX mapping**: - +| Name | Value | +|:--|:--| +| Name | MaxShellsPerUser | +| Friendly Name | Specify maximum number of remote shells per user | +| Location | Computer Configuration | +| Path | Windows Components > Windows Remote Shell | +| Registry Key Name | Software\Policies\Microsoft\Windows\WinRM\Service\WinRS | +| ADMX File Name | WindowsRemoteShell.admx | + -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|No|No| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| + + + - -
+ - -[Scope](./policy-configuration-service-provider.md#policy-scope): + +## SpecifyShellTimeout -> [!div class = "checklist"] -> * Device + +| 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] and later | + -
+ +```Device +./Device/Vendor/MSFT/Policy/Config/RemoteShell/SpecifyShellTimeout +``` + - - + + This policy setting is deprecated and has no effect when set to any state: Enabled, Disabled, or Not Configured. + - + + + - -ADMX Info: -- GP Friendly name: *Specify Shell Timeout* -- GP name: *ShellTimeOut* -- GP path: *Windows Components/Windows Remote Shell* -- GP ADMX file name: *WindowsRemoteShell.admx* + +**Description framework properties**: - - -
+| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + - + +> [!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) \ No newline at end of file +| Name | Value | +|:--|:--| +| Name | ShellTimeOut | +| Friendly Name | Specify Shell Timeout | +| Location | Computer Configuration | +| Path | Windows Components > Windows Remote Shell | +| Registry Key Name | Software\Policies\Microsoft\Windows\WinRM\Service\WinRS | +| ADMX File Name | WindowsRemoteShell.admx | + + + + + + + + + + + + + + +## Related articles + +[Policy configuration service provider](policy-configuration-service-provider.md)