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.

remoteaccess

Add-Bgp Custom Route

Adds custom routes to the BGP routing table.

Add-Bgp Peer

Adds a new BGP peer.

Add-Bgp Route Aggregate

Adds a new aggregate route for specific BGP routes.

Add-Bgp Router

Adds a BGP router for the specified Tenant ID.

Add-Bgp Routing Policy

Adds a BGP routing policy to the policy store.

Add-Bgp Routing Policy For Peer

Adds BGP routing policies to BGP peers.

Add-DAApp Server

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-DAClient Dns Configuration

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

Add-DAEntry Point

Adds an entry point to a multi-site deployment.

Add-DAMgmt Server

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

Add-Remote Access IpFilter

Adds filters for traffic that passes through an interface.

Add-Remote Access Load Balancer Node

Adds a server to the load balancing cluster.

Add-Remote Access Radius

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

Add-Vpn IPAddress Range

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

Add-VpnS2SInterface

Create a S2S interface with the specified parameters.

Add-Vpn Sstp Proxy Rule

Adds a tenant ID to gateway mapping.

Clear-Bgp Route Flap Dampening

Clears the route flap dampening information for the specified set of BGP routes.

Clear-Remote Access Inbox Accounting Store

Clears the inbox accounting store for the specified time period.

Clear-VpnS2SInterface Statistics

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

Connect-VpnS2SInterface

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

Disable-Bgp Route Flap Dampening

Disables route dampening for the flapping BGP routes.

Disable-DAMulti Site

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

Disable-DAOtp Authentication

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

Disable-Remote Access Routing Domain

Disables remote access functions for a routing domain.

Disconnect-VpnS2SInterface

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

Disconnect-Vpn User

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

Enable-Bgp Route Flap Dampening

Enables route dampening for the flapping BGP routes.

Enable-DAMulti Site

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

Enable-DAOtp Authentication

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

Enable-Remote Access Routing Domain

Enables VPN or S2S functions for a specified routing domain.

Get-Bgp Custom Route

Gets custom route information from the BGP router.

Get-Bgp Peer

Gets configuration information for BGP peers.

Get-Bgp Route Aggregate

Gets all the aggregate BGP routes configured by the administrator.

Get-Bgp Route Flap Dampening

Retrieves the configuration of a BGP route dampening engine.

Get-Bgp Route Information

Retrieves BGP route information for one or more network prefixes from the BGP routing table.

Get-Bgp Router

Gets configuration information for BGP routers.

Get-Bgp Routing Policy

Gets configuration information of BGP routing policies.

Get-Bgp Statistics

Retrieves BGP peering-related message and route advertisement statistics.

Get-DAApp Server

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 application servers in the groups.

Get-DAClient

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

Get-DAClient Dns Configuration

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

Get-DAEntry Point

Displays the settings for an entry point.

Get-DAEntry PointDC

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

Get-DAMgmt Server

Displays the configured management servers.

Get-DAMulti Site

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

Get-DANetwork Location Server

Displays the detailed Network Location Server (NLS) configuration.

Get-DAOtp Authentication

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

Get-DAServer

Displays the properties of the DirectAccess (DA) server.

Get-Remote Access

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

Get-Remote Access Accounting

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

Get-Remote Access Configuration

Retrieves the remote access configuration.

Get-Remote Access Connection Statistics

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-Remote Access Connection Statistics Summary

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-Remote Access Health

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

Get-Remote Access IpFilter

Retrieves IP filters on an interface.

Get-Remote Access Load Balancer

Displays load balanced cluster settings.

Get-Remote Access Radius

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-Remote Access Routing Domain

Retrieves configuration information for a routing domain.

Get-Remote Access User Activity

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

Get-Routing Protocol Preference

Displays preferences for routing protocols.

Get-Vpn Auth Protocol

Retrieves authentication parameters configured on a VPN server.

Get-VpnS2SInterface

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

Get-VpnS2SInterface Statistics

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

Get-Vpn Server Configuration

Gets VPN server properties.

Get-Vpn Sstp Proxy Rule

Retrieves the Tenant ID to gateway mapping.

Install-Remote Access

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, installs VPN (both Remote Access VPN and site-to-site VPN), and installs Border Gateway Protocol Routing..

New-Vpn Sstp Proxy Rule

Creates a tenant ID to gateway mapping object.

New-Vpn Traffic Selector

Creates a VPN Traffic selector object that configures the IKE traffic selector.

Remove-Bgp Custom Route

Removes custom routes from the BGP router.

Remove-Bgp Peer

Removes BGP peers from a router.

Remove-Bgp Route Aggregate

Removes the set of specified aggregate BGP routes.

Remove-Bgp Router

Removes a BGP router.

Remove-Bgp Routing Policy

Removes routing policies from the policy store.

Remove-Bgp Routing Policy For Peer

Removes routing policies from BGP peers.

Remove-DAApp Server

Removes the specified list 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-DAClient Dns Configuration

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

Remove-DAEntry Point

Removes an entry point from a multi-site deployment.

Remove-DAMgmt Server

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

Remove-Remote Access IpFilter

Removes an IP filter for an interface.

Remove-Remote Access Load Balancer Node

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

Remove-Remote Access Radius

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-Vpn IPAddress Range

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

Remove-VpnS2SInterface

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

Remove-Vpn Sstp Proxy Rule

Removes one or more tenant IDs to gateway mappings for SSTP proxy.

Set-Bgp Peer

Updates the configuration of the specified BGP peer.

Set-Bgp Route Aggregate

Updates the properties of specified aggregate BGP route.

Set-Bgp Route Flap Dampening

Configures the BGP route dampening engine.

Set-Bgp Router

Updates the configuration of the local BGP router for the specified tenant ID.

Set-Bgp Routing Policy

Modifies a routing policy configuration.

Set-Bgp Routing Policy For Peer

Modifies BGP routing policies for BGP peers.

Set-DAApp Server Connection

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-DAClient Dns Configuration

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

Set-DAEntry Point

Configures settings for the entry point.

Set-DAEntry PointDC

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

Set-DAMulti Site

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

Set-DANetwork Location Server

Configures the Network Location Server (NLS).

Set-DAOtp Authentication

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

Set-DAServer

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

Set-Remote Access

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

Set-Remote Access Accounting

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

Set-Remote Access Configuration

Modifies the configuration of a remote access role.

Set-Remote Access Inbox Accounting Store

Modifies the size of the inbox accounting store.

Set-Remote Access IpFilter

Modifies IP filter action.

Set-Remote Access Load Balancer

Configures load balancing on the Remote Access (RA) server or the cluster server.

Set-Remote Access Radius

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-Remote Access Routing Domain

Configures S2S VPN settings for a routing domain configuration.

Set-Routing Protocol Preference

Configures preferences for routing protocols.

Set-Vpn Auth Protocol

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

Set-Vpn Auth Type

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

Set-Vpn IPAddress Assignment

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

Set-VpnS2SInterface

Updates parameters for an S2S Interface.

Set-Vpn Server Configuration

Updates S2S server parameters.

Set-Vpn Sstp Proxy Rule

This cmdlet updates the tenant ID to gateway mapping for SSTP Proxy.

Start-Bgp Peer

Starts routing sessions for BGP peers.

Stop-Bgp Peer

Stops routing sessions for BGP peers.

Uninstall-Remote Access

Uninstalls DirectAccess (DA) and VPN, both Remote Access (RA) VPN and site-to-site VPN.

Update-DAMgmt Server

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