Get-RemoteAccess

Get-RemoteAccess

Displays the configuration of DirectAccess (DA) and VPN (both Remote Access VPN and site-to-site VPN).

Syntax

Parameter Set: Get0
Get-RemoteAccess [[-EntrypointName] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-RemoteAccess cmdlet displays the configuration of DirectAccess (DA) and VPN (both Remote Access VPN and site-to-site VPN).

The output consists of the following. If a certain Remote Access technology (RA) is not installed, then only the computer status is displayed.
-- Status of DA.
-- Status of VPN.
-- Status of site-to-site VPN.
-- Status of Load Balancing.
-- DA global configuration: Comprises of properties that are applicable to the entire DA deployment.
-- DA server level or cluster level (if load balancing has been deployed) configuration. If multi-site is deployed, then this configuration is applicable at the site-level and configuration for the specified site is displayed.
-- DA pure server and cluster level configuration: This configuration is not impacted by multi-site deployment.
-- VPN server or cluster level configuration. If multi-site is deployed, then this configuration is applicable at the site-level and configuration for the specified site is displayed.
-- VPN pure server level configuration: This configuration is not impacted by multi-site deployment.

In a multi-site deployment if both the EntryPointName and ComputerName parameters are specified but the computer name does not belong to that entry point name, then no values are returned for the pure server-level DA and VPN (both Remote Access VPN and site-to-site VPN)configuration. The configuration will show up blank. However, if only the EntryPointName parameter is specified or the ComputerName parameter is also specified and belongs to the specified entry point name, then the pure server-level DA and VPN configuration are retrieved if the server on which the cmdlet is run belongs to this entry point. If not, then blanks are returned.

Parameters

-AsJob

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

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ComputerName<String>

Specifies the IPv4 or IPv6 address, or host name, of the computer on which the remote access server computer specific tasks should be run.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EntrypointName<String>

Specifies the identity of a site in a multi-site deployment. If this parameter is not specified, then the site to which the computer on which this cmdlet is run is used (the user may or may not be specifying a computer name).


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

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

  • None

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimInstance#RemoteAccessCommon

    The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
    The RemoteAccessCommon object consists of the following properties:
    -- The status of the DA and VPN configuration.
    -- The entire VPN configuration.
    -- The entire DA configuration.
    -- The configuration common to both VPN and DA.


Examples

EXAMPLE 1

This example displays the configuration of DA and VPN for the local computer.


PS C:\> Get-RemoteAccess

Related topics

Community Additions

ADD
Show: