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-RemoteAccessConfiguration

Set-RemoteAccessConfiguration

ps_remoteaccessconfiguration_v1.0.cdxml

Synopsis

Modifies the configuration of a remote access role.

Syntax

Set-RemoteAccessConfiguration [-Configuration] [-AsJob] [-CimSession] [-PassThru] [-RestartServiceIfRequired] [-ThrottleLimit] [<CommonParameters>]

Detailed Description

The Set-RemoteAccessConfiguration cmdlet modifies a remote access role by using a Windows PowerShell object.

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CimSession <CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Configuration <CimInstance>

Specifies a remote access configuration object. To obtain a configuration object, use the Get-CimInstance cmdlet.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RestartServiceIfRequired <SwitchParameter>

Indicates that the Remote Access service restarts if required by any configuration changes.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ThrottleLimit <Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

Microsoft.Management.Infrastructure.CimInstance#RemoteAccessConfiguration

Notes

None

Examples

Example 1: Modify remote access configuration

This command modifies the remote access configuration for a computer.

PS C:\>Set-RemoteAccessConfiguration

Online Version
Get-RemoteAccessConfiguration