Export (0) Print
Expand All
Expand Minimize

Remote Access Cmdlets in Windows PowerShell

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Windows PowerShell® is a task-based command-line shell and scripting language designed especially for system administration. This reference topic for the information technology (IT) professional provides assistance in utilizing the Windows PowerShell cmdlets to script and automate tasks.

Remote Access

This reference provides cmdlet descriptions and syntax for all Remote Access-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.

 

cmdlet Description

Add-BgpCustomRoute

Adds custom routes to the BGP routing table.

Add-BgpPeer

Adds a BGP peer to the current router.

Add-BgpRouter

Adds a BGP router.

Add-BgpRoutingPolicy

Adds a BGP routing policy to the policy store.

Add-BgpRoutingPolicyForPeer

Adds BGP routing policies to BGP peers.

Add-DAAppServer

Adds a new application server security group to the DirectAccess (DA) deployment, adds an application servers to an application server security group that is already part of the DirectAccess deployment, and adds or updates application server Group Policy Object (GPO) in a domain.

Add-DAClient

Adds one or more client computer security groups (SGs) to the DirectAccess (DA) deployment, adds one or more DA client Group Policy objects (GPOs) in one or more domains, adds one or more SGs of down-level clients to the DA deployment in a multi-site deployment, or adds one or more down-level DA client GPOs in one or more domains in a multi-site deployment.

Add-DAClientDnsConfiguration

Adds the specified DNS suffix, DNS server addresses, or proxy server set to the Name Resolution Policy Table (NRPT).

Add-DAEntryPoint

Adds an entry point to a multi-site deployment.

Add-DAMgmtServer

Adds the specified Management servers to the DirectAccess (DA) deployment.

Add-RemoteAccessIpFilter

Adds filters for traffic that passes through an interface.

Add-RemoteAccessLoadBalancerNode

Adds a server to the load balancing cluster.

Add-RemoteAccessRadius

Adds a new external RADIUS server for VPN authentication, accounting for DirectAccess (DA) and VPN, or one-time password (OTP) authentication for DA.

Add-VpnIPAddressRange

Adds a new IPv4 address range from which IPv4 addresses can be assigned to VPN clients.

Add-VpnS2SInterface

Creates a site-to-site (S2S) interface with the specified parameters.

Clear-RemoteAccessInboxAccountingStore

Clears the inbox accounting store for the specified time period.

Clear-VpnS2SInterfaceStatistics

Clears statistics for a site-to-site (S2S) interface.

Connect-VpnS2SInterface

Connects a site-to-site (S2S) interface that is currently not connected.

Disable-DAMultiSite

Disables a multi-site deployment that contains a single entry point.

Disable-DAOtpAuthentication

Disables one-time password (OTP) authentication for DirectAccess (DA) users.

Disable-RemoteAccessRoutingDomain

Disables remote access functions for a routing domain.

Disconnect-VpnS2SInterface

Disconnect a site-to-site (S2S) interface that is currently connected.

Disconnect-VpnUser

Disconnects a VPN connection originated by a specific user or originating from a specific client computer.

Enable-DAMultiSite

Enables and configures a multi-site deployment, and adds the first entry point.

Enable-DAOtpAuthentication

Enables and configures one-time password (OTP) authentication for DirectAccess (DA) users.

Enable-RemoteAccessRoutingDomain

Enables VPN or S2S functions for a specified routing domain.

Get-BgpCustomRoute

Gets custom route information from the BGP router.

Get-BgpPeer

Gets configuration information for BGP peers.

Get-BgpRouteInformation

Gets route information for network prefixes from the BGP router.

Get-BgpRouter

Gets configuration information for BGP routers.

Get-BgpRoutingPolicy

Gets configuration information of BGP routing policies.

Get-BgpStatistics

Retrieves BGP peering-related message and route advertisement statistics.

Get-DAAppServer

Displays the list of application server security groups that are part of the DirectAccess (DA) deployment and the properties of the connections made to the groups.

Get-DAClient

Displays the list of client security groups that are part of the DirectAccess (DA) deployment and the client properties.

Get-DAClientDnsConfiguration

Displays all the Name Resolution Policy Table (NRPT) entries and the local name resolution property.

Get-DAEntryPoint

Displays the settings for an entry point.

Get-DAEntryPointDC

Retrieves a list of entry points and the associated domain controllers (DCs).

Get-DAMgmtServer

Displays the configured Management servers. Management server here refers to update servers, Domain Controllers and other servers.

Get-DAMultiSite

Retrieves global settings applied to all entry points in a multi-site deployment.

Get-DANetworkLocationServer

Displays the detailed Network Location Server (NLS) configuration.

Get-DAOtpAuthentication

Displays one-time password (OTP) authentication settings for DirectAccess (DA).

Get-DAServer

Displays the properties of the DirectAccess (DA) Server.

Get-RemoteAccess

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

Get-RemoteAccessAccounting

Displays the accounting configuration for Remote Access, such as the different types of accounting that are enabled and the respective configuration.

Get-RemoteAccessConfiguration

Retrieves the remote access configuration.

Get-RemoteAccessConnectionStatistics

Displays the statistics of real-time, currently active DirectAccess (DA) and VPN connections and the statistics of DA and VPN historical connections for a specified time duration.

Get-RemoteAccessConnectionStatisticsSummary

Displays the summary statistics of real-time, currently active DirectAccess (DA) and VPN connections and the summary statistics of DA and VPN historical connections for a specified time duration.

Get-RemoteAccessHealth

Obtains the current health of a RemoteAccess (RA) deployment.

Get-RemoteAccessIpFilter

Retrieves IP filters on an interface.

Get-RemoteAccessLoadBalancer

Displays load balanced cluster settings.

Get-RemoteAccessRadius

Displays the list of RADIUS servers including RADIUS for VPN authentication, RADIUS for DirectAccess (DA) and VPN Accounting, and RADIUS for one-time password (OTP) authentication for DA.

Get-RemoteAccessRoutingDomain

Retrieves configuration information for a routing domain.

Get-RemoteAccessUserActivity

Displays the resources accessed over the active DirectAccess (DA) and VPN connections and the resources accessed over historical DA and VPN connections.

Get-RoutingProtocolPreference

Displays preferences for routing protocols.

Get-VpnAuthProtocol

Retrieves authentication parameters configured on a VPN server.

Get-VpnS2SInterface

Retrieves configuration details for a site-to-site (S2S) interface.

Get-VpnS2SInterfaceStatistics

Retrieves statistics of a site-to-site (S2S) interface.

Get-VpnServerConfiguration

Gets VPN server properties.

Install-RemoteAccess

Performs prerequisite checks for DirectAccess (DA) to ensure that it can be installed, installs DA for remote access (RA) (includes management of remote clients) or for management of remote clients only, and installs VPN (both Remote Access VPN and site-to-site VPN).

Remove-BgpCustomRoute

Removes custom routes from the BGP router.

Remove-BgpPeer

Removes BGP peers from a router.

Remove-BgpRouter

Removes the BGP router for tenants.

Remove-BgpRoutingPolicy

Removes routing policies from the policy store.

Remove-BgpRoutingPolicyForPeer

Removes routing policies from BGP peers.

Remove-DAAppServer

Removes the specified lit of application server security groups (SGs) from the DirectAccess (DA) deployment, removes the specified application servers from the specified DA application server SG,and removes the application server Group Policy objects (GPOs) in the specified domains.

Remove-DAClient

Removes one or more client computer security groups (SGs) from the DirectAccess (DA) deployment, removes one or more DA client Group Policy objects (GPOs) from domains, removes one or more SGs of down-level clients (down-level clients can connect only to the specified site) from the DA deployment in a multi-site deployment, and removes one or more down-level DA client GPOs from domains in a multi-site deployment.

Remove-DAClientDnsConfiguration

Removes the Name Resolution Policy Table (NRPT) entry corresponding to the specified DNS suffix from the NRPT.

Remove-DAEntryPoint

Removes an entry point from a multi-site deployment.

Remove-DAMgmtServer

Removes the specified management servers from the DirectAccess (DA) deployment.

Remove-RemoteAccessIpFilter

Removes an IP filter for an interface.

Remove-RemoteAccessLoadBalancerNode

Removes a server from the network load balancing (NLB) cluster.

Remove-RemoteAccessRadius

Removes an external RADIUS server from being used for VPN authentication, accounting for both DirectAccess (DA) and VPN, or one-time password (OTP) authentication for DA.

Remove-VpnIPAddressRange

Removes an existing IPv4 address range from the pool for IP address assignment.

Remove-VpnS2SInterface

Removes a specified site-to-site (S2S) interface.

Set-BgpPeer

Modifies BGP configuration.

Set-BgpRouter

Modifies the local BGP router configuration.

Set-BgpRoutingPolicy

Modifies a routing policy configuration.

Set-BgpRoutingPolicyForPeer

Modifies BGP routing policies for BGP peers.

Set-DAAppServerConnection

Configures the properties of the connection to application servers and the IPsec security traffic protection policies for the connection.

Set-DAClient

Configures the properties related to a DirectAccess (DA) client.

Set-DAClientDnsConfiguration

Configures the DNS server and proxy server addresses of a Name Resolution Policy Table (NRPT) entry and configures the local name resolution property.

Set-DAEntryPoint

Configures settings for the entry point.

Set-DAEntryPointDC

Modifies domain controller (DC) settings for the entry point.

Set-DAMultiSite

Configures global settings for all entry points in a multi-site deployment.

Set-DANetworkLocationServer

Configures the Network Location Server (NLS).

Set-DAOtpAuthentication

Configures one-time password (OTP) authentication settings for DirectAccess (DA).

Set-DAServer

Sets the properties specific to the DirectAccess (DA) server.

Set-RemoteAccess

Modifies the configuration that is common to both DirectAccess (DA) and VPN such as the following: SSL certificate, Internal interface, and Internet interface.

Set-RemoteAccessAccounting

Sets the enabled state for inbox and RADIUS accounting for both external RADIUS and Windows accounting and configures the settings when enabled.

Set-RemoteAccessConfiguration

Modifies the configuration of a remote access role.

Set-RemoteAccessInboxAccountingStore

Modifies the size of the inbox accounting store.

Set-RemoteAccessIpFilter

Modifies IP filter action.

Set-RemoteAccessLoadBalancer

Configures load balancing on the Remote Access server or the cluster server.

Set-RemoteAccessRadius

Edits the properties associated with an external RADIUS server being used for VPN authentication, accounting for DirectAccess (DA) and VPN, and one-time password (OTP) authentication for DA.

Set-RemoteAccessRoutingDomain

Configures S2S VPN settings for a routing domain configuration.

Set-RoutingProtocolPreference

Configures preferences for routing protocols.

Set-VpnAuthProtocol

Sets the authentication method for incoming site-to-site (S2S) VPN interfaces on a Routing and Remote Access (RRAS) server.

Set-VpnAuthType

Sets the authentication type to be used for connecting to a VPN.

Set-VpnIPAddressAssignment

Configures the IPv4 address assignment method or the IPv6 prefix for IPv6 address assignment.

Set-VpnS2SInterface

Modifies parameters for a site-to-site (S2S) interface.

Set-VpnServerConfiguration

Configures VPN server properties.

Start-BgpPeer

Starts routing sessions for BGP peers.

Stop-BgpPeer

Stops routing sessions for BGP peers.

Uninstall-RemoteAccess

Uninstalls DirectAccess (DA) and VPN, both remote access VPN and site-to-site VPN.

Update-DAMgmtServer

Updates the list of Management servers of the DirectAccess (DA) deployment.

noteNote
To list all the cmdlets that are available, use the Get-Command –Module RemoteAccess cmdlet.

For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets:

Get-Help <cmdlet name> -Detailed
Get-Help <cmdlet name> -Examples
Get-Help <cmdlet name> -Full

More Information

For more information about the cmdlets, see the following:



Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft