You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Set-WSManQuickConfig cmdlet configures the computer to receive Windows PowerShell remote commands that are sent by using the Web Services for Management (WS-Management) technology.
26
+
The `Set-WSManQuickConfig` cmdlet configures the computer to receive PowerShell remote commands that
27
+
are sent by using the Web Services for Management (WS-Management) technology.
25
28
26
-
The cmdlet performs the following:
29
+
`Set-WSManQuickConfig`performs the following actions:
27
30
28
-
- Checks whether the WinRM service is running. If the WinRM service is not running, the service is started.
31
+
- Checks whether the WinRM service is running. If the WinRM service isn't running, the service is
32
+
started.
29
33
- Sets the WinRM service startup type to automatic.
30
-
- Creates a listener to accept requests on any IP address. By default, the transport is HTTP.
31
-
- Enables a firewall exception for WinRM traffic.
34
+
- Creates a listener to accept requests on any IP address. The defaulttransport is **HTTP**.
35
+
- Enables a firewall exception for WinRM traffic.
32
36
33
-
To run this cmdlet, start Windows PowerShell with the "Run as administrator" option.
37
+
To run `Set-WSManQuickConfig`, start PowerShell with the **Run as Administrator** option.
34
38
35
39
## EXAMPLES
36
40
37
-
### Example 1
41
+
### Example 1: Enable remote management of the local computer over HTTP
42
+
43
+
This example sets the required configuration to enable remote management of the local computer. By
44
+
default, this command creates a WS-Management listener on **HTTP**.
38
45
39
46
```powershell
40
47
Set-WSManQuickConfig
41
48
```
42
49
43
-
This command sets the required configuration to enable remote management of the local computer.
44
-
By default, this command creates a WS-Management listener on HTTP.
50
+
### Example 2: Enable remote management of the local computer over HTTPS
45
51
46
-
### Example 2
52
+
This example sets the required configuration to enable remote management of the local computer. The
53
+
**UseSSL** parameter specifies that **HTTPS** is used to communicate with the computer.
47
54
48
55
```powershell
49
56
Set-WSManQuickConfig -UseSSL
50
57
```
51
58
52
-
The command sets the required configuration to enable remote management of the local computer.
53
-
The UseSSL parameter makes the command create a WS-Management listener on HTTPS.
59
+
> [!NOTE]
60
+
> **HTTPS** requires manual configuration. For more information, see the **UseSSL** parameter's
61
+
> description.
54
62
55
63
## PARAMETERS
56
64
57
65
### -Force
58
66
59
-
Sets the configuration without first prompting the user.
67
+
Forces the command to run without asking for user confirmation.
60
68
61
69
```yaml
62
70
Type: SwitchParameter
@@ -65,22 +73,25 @@ Aliases:
65
73
66
74
Required: False
67
75
Position: Named
68
-
Default value: None
76
+
Default value: False
69
77
Accept pipeline input: False
70
78
Accept wildcard characters: False
71
79
```
72
80
73
81
### -SkipNetworkProfileCheck
74
82
75
-
Configures client versions of Windows for remoting when the computer is on a public network.
76
-
This parameter enables a firewall rule for public networks that allows remote access only from computers in the same local subnet.
83
+
Configures Windows client versions for remoting when the computer is on a public network. This
84
+
parameter enables a firewall rule for public networks that allows remote access only from computers
85
+
in the same local subnet.
77
86
78
-
This parameter has no effect on server versions of Windows, which, by default, have a local subnet firewall rule for public networks.
79
-
If the local subnet firewall rule is disabled on a server version of Windows, **Enable-PSRemoting** re-enables it, regardless of the value of this parameter.
87
+
This parameter has no effect on server versions of Windows, that by default, have a local subnet
88
+
firewall rule for public networks. If the local subnet firewall rule is disabled on the server
89
+
version of Windows, `Enable-PSRemoting` re-enables it, regardless of this parameter's value.
80
90
81
-
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.
91
+
To remove the local subnet restriction and enable remote access from all locations on public
92
+
networks, use the `Set-NetFirewallRule` cmdlet in the **NetSecurity** module.
82
93
83
-
This parameter is introduced in Windows PowerShell 3.0.
94
+
This parameter was introduced in PowerShell 3.0.
84
95
85
96
```yaml
86
97
Type: SwitchParameter
@@ -89,19 +100,23 @@ Aliases:
89
100
90
101
Required: False
91
102
Position: Named
92
-
Default value: None
103
+
Default value: False
93
104
Accept pipeline input: False
94
105
Accept wildcard characters: False
95
106
```
96
107
97
108
### -UseSSL
98
109
99
-
Specifies that the Secure Sockets Layer (SSL) protocol should be used to establish a connection to the remote computer.
100
-
By default, SSL is not used.
110
+
Specifies that the Secure Sockets Layer (SSL) protocol is used to establish a connection to the
111
+
remote computer. By default, SSL isn't used.
101
112
102
-
WS-Management encrypts all Windows PowerShell content transmitted over the network.
103
-
The UseSSL parameter lets you specify that the additional protection of using HTTPS instead of HTTP should be used.
104
-
If you specify this parameter, but SSL is not available on the port used for the connection, the command fails.
113
+
WS-Management encrypts all the PowerShell content that is transmitted over the network. The
114
+
**UseSSL** parameter lets you specify the additional protection of HTTPS instead of HTTP. If you use
115
+
this parameter and SSL isn't available on the port that's used for the connection, the command
116
+
fails.
117
+
118
+
**HTTPS** requires manual configuration of WinRM and firewall rules. For more information, see
119
+
[How To: Configure WINRM for HTTPS](https://support.microsoft.com/en-us/help/2019527/how-to-configure-winrm-for-https).
105
120
106
121
```yaml
107
122
Type: SwitchParameter
@@ -110,53 +125,55 @@ Aliases:
110
125
111
126
Required: False
112
127
Position: Named
113
-
Default value: None
128
+
Default value: False
114
129
Accept pipeline input: False
115
130
Accept wildcard characters: False
116
131
```
117
132
118
133
### CommonParameters
119
134
120
-
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).
135
+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
0 commit comments