Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-WSManQuickConfig

Set-WSManQuickConfig

microsoft.wsman.management.dll

Synopsis

Configures the local computer for remote management.

Syntax

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

Detailed 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:

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

-- Sets the WinRM service startup type to automatic.

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

-- Enables a firewall exception for WinRM traffic .

To run this cmdlet, start Windows PowerShell with the "Run as administrator" option.

Parameters

-Force <SwitchParameter>

Sets the configuration without first prompting the user.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-SkipNetworkProfileCheck <SwitchParameter>

Configures client versions of Windows for remoting 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.

This parameter has no effect on server versions of Windows, which, by default, have a local subnet firewall rule for public networks. 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.

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.

This parameter is introduced in Windows PowerShell 3.0.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-UseSSL <SwitchParameter>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

None

Notes

None

Examples

-------------------------- EXAMPLE 1 --------------------------

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.

PS C:\>Set-WSManQuickConfig

-------------------------- EXAMPLE 2 --------------------------

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.

PS C:\>Set-WSManQuickConfig -UseSSL

Online Version
Enable-PSRemoting
New-PSSession
Connect-WSMan
Disable-WSManCredSSP
Disconnect-WSMan
Enable-WSManCredSSP
Get-WSManCredSSP
Get-WSManInstance
Invoke-WSManAction
New-WSManInstance
New-WSManSessionOption
Test-WSMan