Remote Access Cmdlets in Windows PowerShell
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 |
|---|---|
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. |
|
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. |
|
Adds the specified DNS suffix, DNS server addresses, or proxy server set to the Name Resolution Policy Table (NRPT). |
|
Adds an entry point to a multi-site deployment. |
|
Adds the specified Management servers to the DirectAccess (DA) deployment. |
|
Adds a server to the load balancing cluster. |
|
Adds a new external RADIUS server for VPN authentication, accounting for DirectAccess (DA) and VPN, or one-time password (OTP) authentication for DA. |
|
Adds a new IPv4 address range from which IPv4 addresses can be assigned to VPN clients. |
|
Creates a site-to-site (S2S) interface with the specified parameters. |
|
Clears the inbox accounting store for the specified time period. |
|
Clears statistics for a site-to-site (S2S) interface. |
|
Connects a site-to-site (S2S) interface that is currently not connected. |
|
Disables a multi-site deployment that contains a single entry point. |
|
Disable-DAOtpAuthenticationAuth |
Disables one-time password (OTP) authentication for DirectAccess (DA) users. |
Disconnect a site-to-site (S2S) interface that is currently connected. |
|
Disconnects a VPN connection originated by a specific user or originating from a specific client computer. |
|
Enables and configures a multi-site deployment, and adds the first entry point. |
|
Enable-DAOtpAuthenticationAuth |
Enables and configures one-time password (OTP) authentication for DirectAccess (DA) users. |
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. |
|
Displays the list of client security groups that are part of the DirectAccess (DA) deployment and the client properties. |
|
Displays all the Name Resolution Policy Table (NRPT) entries and the local name resolution property. |
|
Displays the settings for an entry point. |
|
Retrieves a list of entry points and the associated domain controllers (DCs). |
|
Displays the configured Management servers. Management server here refers to update servers, Domain Controllers and other servers. |
|
Retrieves global settings applied to all entry points in a multi-site deployment. |
|
Displays the detailed Network Location Server (NLS) configuration. |
|
Get-DAOtpAuthenticationAuth |
Displays one-time password (OTP) authentication settings for DirectAccess (DA). |
Displays the properties of the DirectAccess (DA) Server. |
|
Displays the configuration of DirectAccess (DA) and VPN (both Remote Access VPN and site-to-site VPN). |
|
Displays the accounting configuration for Remote Access, such as the different types of accounting that are enabled and the respective configuration. |
|
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. |
|
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. |
|
Obtains the current health of a RemoteAccess (RA) deployment. |
|
Displays load balanced cluster settings. |
|
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. |
|
Displays the resources accessed over the active DirectAccess (DA) and VPN connections and the resources accessed over historical DA and VPN connections. |
|
Retrieves authentication parameters configured on a VPN server. |
|
Retrieves configuration details for a site-to-site (S2S) interface. |
|
Retrieves statistics of a site-to-site (S2S) interface. |
|
Gets IPsec parameters configured on the VPN server. |
|
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). |
|
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. |
|
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. |
|
Removes the Name Resolution Policy Table (NRPT) entry corresponding to the specified DNS suffix from the NRPT. |
|
Removes an entry point from a multi-site deployment. |
|
Removes the specified management servers from the DirectAccess (DA) deployment. |
|
Removes a server from the network load balancing (NLB) cluster. |
|
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. |
|
Removes an existing IPv4 address range from the pool for IP address assignment. |
|
Removes a specified site-to-site (S2S) interface. |
|
Configures the properties related to a DirectAccess (DA) client. |
|
Configures the DNS server and proxy server addresses of a Name Resolution Policy Table (NRPT) entry and configures the local name resolution property. |
|
Configures settings for the entry point. |
|
Modifies domain controller (DC) settings for the entry point. |
|
Configures global settings for all entry points in a multi-site deployment. |
|
Configures the Network Location Server (NLS). |
|
Set-DAOtpAuthenticationAuth |
Configures one-time password (OTP) authentication settings for DirectAccess (DA). |
Sets the properties specific to the DirectAccess (DA) server. |
|
Modifies the configuration that is common to both DirectAccess (DA) and VPN such as the following: SSL certificate, Internal interface, and Internet interface. |
|
Sets the enabled state for inbox and RADIUS accounting for both external RADIUS and Windows accounting and configures the settings when enabled. |
|
Modifies the size of the inbox accounting store. |
|
Configures load balancing on the Remote Access server or the cluster server. |
|
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. |
|
Sets the authentication method for incoming site-to-site (S2S) VPN interfaces on a Routing and Remote Access (RRAS) server. |
|
Sets the authentication type to be used for connecting to a VPN. |
|
Configures the IPv4 address assignment method or the IPv6 prefix for IPv6 address assignment. |
|
Modifies parameters for a site-to-site (S2S) interface. |
|
Sets the IPsec parameters for a site-to-site (S2S) server. |
|
Uninstalls DirectAccess (DA) and VPN, both remote access VPN and site-to-site VPN. |
|
Updates the list of Management servers of the DirectAccess (DA) deployment. |
注意
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:
-