VPN Client Cmdlets in Windows PowerShell

  • Article

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 based on the verb at the beginning of the cmdlet.

Cmdlet Description

Add-VpnConnection

Adds a VPN connection to the Connection Manager phone book.

Get-VpnConnection

Retrieves the specified VPN connection profile information.

New-EapConfiguration

Generates a new XML file with the specified EAP configuration.

Remove-VpnConnection

Removes the specified VPN connection profile.

Set-VpnConnection

Changes the configuration settings of an existing VPN connection profile.

Set-VpnConnectionProxy

Configures web proxy information for the specified VPN connection.

Notes

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