From b6926948693c1ff9b800ccc7db87dc7535068712 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Mon, 25 Nov 2024 08:34:50 -0600 Subject: [PATCH] Remove outdated information add links to how-to --- .../Enable-PSRemoting.md | 105 ++++++++---------- .../Enable-PSRemoting.md | 18 +-- .../Enable-PSRemoting.md | 18 +-- 3 files changed, 67 insertions(+), 74 deletions(-) diff --git a/reference/5.1/Microsoft.PowerShell.Core/Enable-PSRemoting.md b/reference/5.1/Microsoft.PowerShell.Core/Enable-PSRemoting.md index 865c1b011dcf..a1b3dd521f06 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/Enable-PSRemoting.md +++ b/reference/5.1/Microsoft.PowerShell.Core/Enable-PSRemoting.md @@ -2,7 +2,7 @@ external help file: System.Management.Automation.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Core -ms.date: 10/06/2023 +ms.date: 11/25/2024 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/enable-psremoting?view=powershell-5.1&WT.mc_id=ps-gethelp schema: 2.0.0 title: Enable-PSRemoting @@ -15,7 +15,8 @@ Configures the computer to receive remote commands. ## SYNTAX ``` -Enable-PSRemoting [-Force] [-SkipNetworkProfileCheck] [-WhatIf] [-Confirm] [] +Enable-PSRemoting [-Force] [-SkipNetworkProfileCheck] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -23,17 +24,17 @@ Enable-PSRemoting [-Force] [-SkipNetworkProfileCheck] [-WhatIf] [-Confirm] [ [!CAUTION] -> On systems that have both PowerShell 3.0 and PowerShell 2.0, do not use -> PowerShell 2.0 to run the `Enable-PSRemoting` and `Disable-PSRemoting` cmdlets. The commands -> might appear to succeed, but the remoting is not configured correctly. Remote commands and later -> attempts to enable and disable remoting, are likely to fail. +For more information about using PowerShell remoting, see the following articles: + +- [about_Remote_Requirements](about/about_Remote_Requirements.md) +- [about_Remote](about/about_Remote.md) ## EXAMPLES @@ -109,7 +109,7 @@ domain networks. The command uses the **SkipNetworkProfileCheck** parameter to a from public networks in the same local subnet. The command specifies the **Force** parameter to suppress confirmation messages. -The **SkipNetworkProfileCheck** parameter does not affect server versions of the Windows operating +The **SkipNetworkProfileCheck** parameter doesn't affect server versions of the Windows operating system, which allow remote access from public networks in the same local subnet by default. The `Set-NetFirewallRule` cmdlet in the **NetSecurity** module adds a firewall rule that allows @@ -141,13 +141,12 @@ Accept wildcard characters: False ### -SkipNetworkProfileCheck Indicates that this cmdlet enables remoting on client versions of the Windows operating system when -the computer is on a public network. This parameter enables a firewall rule for public networks -that allows remote access only from computers in the same local subnet. +the computer is on a public network. This parameter enables a firewall rule for public networks that +allows remote access only from computers in the same local subnet. -This parameter does not affect server versions of the Windows operating system, which, by default, -have a local subnet firewall rule for public networks. If the local subnet firewall rule is -disabled on a server version, `Enable-PSRemoting` re-enables it, regardless of the value of this -parameter. +This parameter doesn't affect server versions of the Windows operating system, which, by default, +have a local subnet firewall rule for public networks. If the local subnet firewall rule is disabled +on a server version, `Enable-PSRemoting` re-enables it, regardless of the value of this parameter. To remove the local subnet restriction and enable remote access from all locations on public networks, use the `Set-NetFirewallRule` cmdlet in the **NetSecurity** module. @@ -184,8 +183,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter @@ -203,7 +201,8 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -219,42 +218,28 @@ This cmdlet returns strings that describe its results. ## NOTES -In PowerShell 3.0, `Enable-PSRemoting` creates the following firewall exceptions for -WS-Management communications. - -On server versions of the Windows operating system, `Enable-PSRemoting` creates firewall rules -for private and domain networks that allow remote access, and creates a firewall rule for public -networks that allows remote access only from computers in the same local subnet. - -On client versions of the Windows operating system, `Enable-PSRemoting` in PowerShell 3.0 creates -firewall rules for private and domain networks that allow unrestricted remote access. To create a -firewall rule for public networks that allows remote access from the same local subnet, use the -**SkipNetworkProfileCheck** parameter. - -On client or server versions of the Windows operating system, to create a firewall rule for public -networks that removes the local subnet restriction and allows remote access , use the -`Set-NetFirewallRule` cmdlet in the NetSecurity module to run the following command: -`Set-NetFirewallRule -Name "WINRM-HTTP-In-TCP-PUBLIC" -RemoteAddress Any` +Starting in PowerShell 3.0, `Enable-PSRemoting` enables all session configurations by setting the +value of the **Enabled** property of all session configurations to `$True`. -In PowerShell 2.0, `Enable-PSRemoting` creates the following firewall exceptions for WS-Management -communications. +- On server versions of the Windows operating system, `Enable-PSRemoting` creates firewall rules for + private and domain networks that allow remote access, and creates a firewall rule for public + networks that allows remote access only from computers in the same local subnet. -On server versions of the Windows operating system, it creates firewall rules for all networks that -allow remote access. +- On client versions of the Windows operating system, `Enable-PSRemoting` in PowerShell 3.0 creates + firewall rules for private and domain networks that allow unrestricted remote access. To create a + firewall rule for public networks that allows remote access from the same local subnet, use the + **SkipNetworkProfileCheck** parameter. -On client versions of the Windows operating system, `Enable-PSRemoting` in PowerShell 2.0 -creates a firewall exception only for domain and private network locations. To minimize security -risks, `Enable-PSRemoting` does not create a firewall rule for public networks on client versions -of Windows. When the current network location is public, `Enable-PSRemoting` returns the following -message: Unable to check the status of the firewall. +- On client or server versions of the Windows operating system, to create a firewall rule for public + networks that removes the local subnet restriction and allows remote access , use the + `Set-NetFirewallRule` cmdlet in the NetSecurity module to run the following command: + `Set-NetFirewallRule -Name "WINRM-HTTP-In-TCP-PUBLIC" -RemoteAddress Any` -Starting in PowerShell 3.0, `Enable-PSRemoting` enables all session configurations by setting the -value of the **Enabled** property of all session configurations to `$True`. +`Enable-PSRemoting` enables all session configurations by setting the value of the **Enabled** +property of all session configurations to `$True`. -In PowerShell 2.0, `Enable-PSRemoting` removes the **Deny_All** setting from the security -descriptor of session configurations. In PowerShell 3.0, `Enable-PSRemoting` removes the -**Deny_All** and **Network_Deny_All** settings. This provides remote access to session -configurations that were reserved for local use. +`Enable-PSRemoting` removes the **Deny_All** and **Network_Deny_All** settings. This provides remote +access to session configurations that were reserved for local use. ## RELATED LINKS diff --git a/reference/7.4/Microsoft.PowerShell.Core/Enable-PSRemoting.md b/reference/7.4/Microsoft.PowerShell.Core/Enable-PSRemoting.md index f2ec88fed102..4ca1a427e44d 100644 --- a/reference/7.4/Microsoft.PowerShell.Core/Enable-PSRemoting.md +++ b/reference/7.4/Microsoft.PowerShell.Core/Enable-PSRemoting.md @@ -2,7 +2,7 @@ external help file: System.Management.Automation.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Core -ms.date: 10/06/2023 +ms.date: 11/25/2024 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/enable-psremoting?view=powershell-7.4&WT.mc_id=ps-gethelp schema: 2.0.0 title: Enable-PSRemoting @@ -31,9 +31,9 @@ PowerShell remoting is enabled by default on Windows Server platforms. You can u `Enable-PSRemoting` to enable PowerShell remoting on other supported versions of Windows and to re-enable remoting if it becomes disabled. -You have to run this command only one time on each computer that will receive commands. You do not -have to run it on computers that only send commands. Because the configuration starts listeners to -accept remote connections, it is prudent to run it only where it is needed. +You need to run this command only one time on each computer that receive commands. You don't need to +run it on computers that only send commands. Because the configuration starts listeners, it's +prudent to run it only where it's needed. Enabling PowerShell remoting on client versions of Windows when the computer is on a public network is normally disallowed, but you can skip this restriction by using the **SkipNetworkProfileCheck** @@ -81,6 +81,11 @@ option. This cmdlet is not available on Linux or MacOS versions of PowerShell. > disable PowerShell remoting endpoints that are hosted by Windows PowerShell, run the > `Enable-PSRemoting` cmdlet from within a Windows PowerShell session. +For more information about using PowerShell remoting, see the following articles: + +- [about_Remote_Requirements](about/about_Remote_Requirements.md) +- [about_Remote](about/about_Remote.md) + ## EXAMPLES ### Example 1: Configure a computer to receive remote commands @@ -237,7 +242,7 @@ Indicates that this cmdlet enables remoting on client versions of the Windows op the computer is on a public network. This parameter enables a firewall rule for public networks that allows remote access only from computers in the same local subnet. -This parameter does not affect server versions of the Windows operating system, which, by default, +This parameter doesn't affect server versions of the Windows operating system, which, by default, have a local subnet firewall rule for public networks. If the local subnet firewall rule is disabled on a server version, `Enable-PSRemoting` re-enables it, regardless of the value of this parameter. @@ -276,8 +281,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/reference/7.5/Microsoft.PowerShell.Core/Enable-PSRemoting.md b/reference/7.5/Microsoft.PowerShell.Core/Enable-PSRemoting.md index eb1e92c17bc2..f5f854168e60 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/Enable-PSRemoting.md +++ b/reference/7.5/Microsoft.PowerShell.Core/Enable-PSRemoting.md @@ -2,7 +2,7 @@ external help file: System.Management.Automation.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Core -ms.date: 10/06/2023 +ms.date: 11/25/2024 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/enable-psremoting?view=powershell-7.5&WT.mc_id=ps-gethelp schema: 2.0.0 title: Enable-PSRemoting @@ -31,9 +31,9 @@ PowerShell remoting is enabled by default on Windows Server platforms. You can u `Enable-PSRemoting` to enable PowerShell remoting on other supported versions of Windows and to re-enable remoting if it becomes disabled. -You have to run this command only one time on each computer that will receive commands. You do not -have to run it on computers that only send commands. Because the configuration starts listeners to -accept remote connections, it is prudent to run it only where it is needed. +You need to run this command only one time on each computer that receive commands. You don't need to +run it on computers that only send commands. Because the configuration starts listeners, it's +prudent to run it only where it's needed. Enabling PowerShell remoting on client versions of Windows when the computer is on a public network is normally disallowed, but you can skip this restriction by using the **SkipNetworkProfileCheck** @@ -81,6 +81,11 @@ option. This cmdlet is not available on Linux or MacOS versions of PowerShell. > disable PowerShell remoting endpoints that are hosted by Windows PowerShell, run the > `Enable-PSRemoting` cmdlet from within a Windows PowerShell session. +For more information about using PowerShell remoting, see the following articles: + +- [about_Remote_Requirements](about/about_Remote_Requirements.md) +- [about_Remote](about/about_Remote.md) + ## EXAMPLES ### Example 1: Configure a computer to receive remote commands @@ -237,7 +242,7 @@ Indicates that this cmdlet enables remoting on client versions of the Windows op the computer is on a public network. This parameter enables a firewall rule for public networks that allows remote access only from computers in the same local subnet. -This parameter does not affect server versions of the Windows operating system, which, by default, +This parameter doesn't affect server versions of the Windows operating system, which, by default, have a local subnet firewall rule for public networks. If the local subnet firewall rule is disabled on a server version, `Enable-PSRemoting` re-enables it, regardless of the value of this parameter. @@ -276,8 +281,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter