Set-WSManQuickConfig

Article
04/20/2010

Applies To: Windows PowerShell 2.0

Configures the local computer for remote management.

Syntax

Set-WSManQuickConfig [-Force] [-UseSSL] [<CommonParameters>]

Description

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.

The cmdlet performs the following:

1. Checks whether the WinRM service is running. If the WinRM service is not running, the service is started.

2. Sets the WinRM service startup type to automatic.

3. Creates a listener to accept requests on any IP address. By default, the transport is HTTP.

4. Enables a firewall exception for WinRM traffic .

To run this cmdlet in Windows Vista, Windows Server 2008, and later versions of Windows, you must start Windows PowerShell with the "Run as administrator" option.

Parameters

-Force

Sets the configuration without first prompting the user.

Required?	false
Position?	named
Default Value
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-UseSSL

Specifies that the Secure Sockets Layer (SSL) protocol should be used to establish a connnection to the remote computer. By default, SSL is not used.

WS-Management encrypts all Windows PowerShell content transmitted over the network. The UseSSL parameter lets you specify that the additional protection of using HTTPS instead of HTTP should be used. If you specify this parameter, but SSL is not available on the port used for the connection, the command fails.

Required?	false
Position?	named
Default Value
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This command supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see about_CommonParameters.

Inputs and Outputs

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet returns.

Inputs

None

This cmdlet does not accept any input.

Outputs

None

This cmdlet does not generate any output.

Example 1

C:\PS>Set-WSManQuickConfig

Description
-----------
This command sets the required configuration to enable remote management of the local computer. By default, this command creates a WS-Management listener on HTTP.

Example 2

C:\PS>Set-WSManQuickConfig -UseSSL

Description
-----------
The command sets the required configuration to enable remote management of the local computer. The UseSSL parameter makes the command create a WS-Management listener on HTTPS.

Share via