COMMAND EVERYTHING.

Add-VpnConnection

Adds a VPN connection to the Connection Manager phone book.

Networking / Security · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft VpnClient reference: Adds a VPN connection to the Connection Manager phone book. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.

Add-VpnConnection [-Name] <String> [-ServerAddress] <String> [-RememberCredential] [-SplitTunneling] [-Force]
 [-PassThru] [-ServerList <CimInstance[]>] [-DnsSuffix <String>] [-IdleDisconnectSeconds <UInt32>]
 [-PlugInApplicationID] <String> -CustomConfiguration <XmlDocument> [-CimSession <CimSession[]>]
 [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Add-VpnConnection. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.

Supported environments

Windows / VpnClient · Windows Server 2025 documentation; feature/module prerequisites apply

Parameters

-AllUserConnection: Indicates that the cmdlet adds the VPN connection to the global phone book entries.
-AsJob: Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
-AuthenticationMethod: Specifies the authentication method to use for the VPN connection.
-CimSession: Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
-Confirm: Prompts you for confirmation before running the cmdlet.
-CustomConfiguration (required): Specifies an XML document that allows vendors to specify custom configuration information.
-DnsSuffix: Specifies the DNS suffix of the VPN connection.
-EapConfigXmlStream: Specifies the contents of the EAP XML configuration file, which includes the EAP method ID.
-EncryptionLevel: Specifies the encryption level for the VPN connection.
-Force: Indicates that the pre-shared key (PSK) value is supplied over an insecure channel, if L2TP is used.
-IdleDisconnectSeconds: Specifies the time, in seconds, before an idle connection is closed.
-L2tpPsk: Specifies the value of the PSK to be used for L2TP authentication. If this parameter is not specified, a certificate is used for L2TP.
-MachineCertificateEKUFilter: Specifies an array of enhanced key usage (EKU) filters for Internet Key Exchange version 2 (IKEv2) machine certificate selection.
-MachineCertificateIssuerFilter: Specifies the X509 certificate of the issuer filter for IKEv2 machine certificate selection.
-Name (required): Specifies the name of this VPN connection profile.
-PassThru: Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
-PlugInApplicationID (required): Specifies the identifier for a third party application.
-RememberCredential: Indicates that the credentials supplied at the time of first successful connection are stored in the cache.
-ServerAddress (required): Specifies the address of the remote VPN server to which the client connects. You can specify the address as a URL, an IPv4 address, or an IPv6 address.
-ServerList: Specifies an array of VPN servers. The VPN client can connect to these servers.
-SplitTunneling: Indicates that the cmdlet enables split tunneling for this VPN connection profile. When you enable split tunneling, traffic to destinations outside the intranet does not flow through the VPN tunnel. If you do not specify this parameter, split tunneling is disabled.
-ThrottleLimit: Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
-TunnelType: Specifies the type of tunnel used for the VPN connection.
-UseWinlogonCredential: Indicates that MSCHAPv2 or EAP MSCHAPv2 is used as the authentication method, and that Windows logon credentials are used automatically when connecting with this VPN connection profile.
-WhatIf: Shows what would happen if the cmdlet runs. The cmdlet is not run.

Prerequisites

Windows with the VpnClient module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.

Security considerations

This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.

Examples

Example 1: Add a VPN connection

Add-VpnConnection -Name "Test1" -ServerAddress "10.1.1.1" -PassThru

This command adds a VPN connection named Test1 to the server with an IP address 10.1.1.1. By specifying the *PassThru* parameter, you can see the configuration of the VPN connection object. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/VpnClient/Add-VpnConnection.md

https://learn.microsoft.com/powershell/module/vpnclient/add-vpnconnection?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands

Get-NetIPInterface

Add-MpPreference

Get-MpPerformanceReport

Add-DhcpServerInDC