VPN Client Cmdlets in Windows PowerShell

Updated: September 23, 2016

Applies To: Windows 10, Windows PowerShell 5.0, Windows Server Technical Preview

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.

VPN Client

This reference provides cmdlet descriptions and syntax for all VPN Client-specific cmdlets. It lists the cmdlets in alphabetical order.

 

Cmdlet Description

Add-VpnConnection

Adds a VPN connection to the Connection Manager phone book.

Add-VpnConnectionRoute

Adds a route to a VPN connection.

Add-VpnConnectionTriggerApplication

Adds applications that automatically trigger a VPN connection when launched.

Add-VpnConnectionTriggerDnsConfiguration

Adds a DNS suffix or name to VPN connection trigger properties.

Add-VpnConnectionTriggerTrustedNetwork

Adds DNS suffixes as trusted networks to the VPN profile.

Get-VpnConnection

Retrieves the specified VPN connection profile information.

Get-VpnConnectionTrigger

Gets trigger properties of a VPN connection.

New-EapConfiguration

Generates an XML file with the specified EAP configuration.

New-VpnServerAddress

Creates a VPN server address object.

Remove-VpnConnection

Removes specified VPN connection profiles.

Remove-VpnConnectionRoute

Removes a route from a VPN connection.

Remove-VpnConnectionTriggerApplication

Removes a trigger application from a VPN connection object.

Remove-VpnConnectionTriggerDnsConfiguration

Removes DNS suffixes from VPN connection DNS trigger properties.

Remove-VpnConnectionTriggerTrustedNetwork

Removes DNS suffixes previously configured as trusted networks from the VPN profile.

Set-VpnConnection

Changes the configuration settings of an existing VPN connection profile.

Set-VpnConnectionIPsecConfiguration

Sets the IPsec parameters of a VPN connection.

Set-VpnConnectionProxy

Configures web proxy information for the specified VPN connection.

Set-VpnConnectionTriggerDnsConfiguration

Changes DNS servers for an existing DNS suffix.

Set-VpnConnectionTriggerTrustedNetwork

Sets the trusted network list.

noteNote
To list all the cmdlets that are available, use the Get-Command –Module VpnClient 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

Community Additions

ADD
Show: