Add-VpnConnection

Add-VpnConnection

Adds a VPN connection to the Connection Manager phone book.

Syntaxe

Parameter Set: InboxProfile
Add-VpnConnection [-Name] <String> [-ServerAddress] <String> [[-TunnelType] <String> ] [[-EncryptionLevel] <String> ] [[-AuthenticationMethod] <String[]> ] [[-SplitTunneling]] [[-AllUserConnection]] [[-L2tpPsk] <String> ] [[-RememberCredential]] [[-UseWinlogonCredential]] [[-EapConfigXmlStream] <XmlDocument> ] [-AsJob] [-CimSession <CimSession[]> ] [-DnsSuffix <String> ] [-Force] [-IdleDisconnectSeconds <UInt32> ] [-MachineCertificateEKUFilter <String[]> ] [-MachineCertificateIssuerFilter <X509Certificate2> ] [-PassThru] [-ServerList <CimInstance[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

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

Description détaillée

The Add-VpnConnection cmdlet adds a VPN connection with the specified parameters to the Connection Manager phone book. If errors occur when you create the VPN profile, the cmdlet returns the error information.

Paramètres

-AllUserConnection

Indicates that the cmldet adds the VPN connection to the global phone book entries.

Alias

none

Obligatoire ?

false

Position ?

8

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-AsJob

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-AuthenticationMethod<String[]>

Specifies the authentication method to use for the VPN connection. Les valeurs acceptables pour ce paramètre sont : PAP, CHAP, MSCHAPv2, or EAP.

Alias

none

Obligatoire ?

false

Position ?

6

Valeur par défaut

MSChapv2

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-CimSession<CimSession[]>

Exécute l’applet de commande dans une session à distance ou sur un ordinateur distant. Entrez un nom d’ordinateur ou un objet de session, comme la sortie d’une applet de commande New-CimSession ou Get-CimSession. La valeur par défaut est la session active sur l’ordinateur local.

Alias

Session

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-CustomConfiguration<XmlDocument>

Specifies an XML document that allows vendors to specify custom configuration information.

Alias

none

Obligatoire ?

true

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-DnsSuffix<String>

Specifies the DNS suffix of the VPN connection.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-EapConfigXmlStream<XmlDocument>

Specifies the contents of the EAP XML configuration file, which includes the EAP method ID.

Alias

none

Obligatoire ?

false

Position ?

12

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-EncryptionLevel<String>

Specifies the encryption level for the VPN connection. Les valeurs acceptables pour ce paramètre sont : NoEncryption, Optional, Required and Maximum.

Alias

none

Obligatoire ?

false

Position ?

5

Valeur par défaut

Required

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-Force

Indicates that the pre-shared key (PSK) value is supplied over an insecure channel, if L2TP is used.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-IdleDisconnectSeconds<UInt32>

Specifies the time, in seconds, before an idle connection is closed.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-L2tpPsk<String>

Specifies the value of the PSK to be used for L2TP authentication. If this parameter is not specified, a certificate is used for L2TP.

Alias

none

Obligatoire ?

false

Position ?

9

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-MachineCertificateEKUFilter<String[]>

Specifies an array of enhanced key usage (EKU) filters for Internet Key Exchange version 2 (IKEv2) machine certificate selection.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-MachineCertificateIssuerFilter<X509Certificate2>

Specifies the X509 certificate of the issuer filter for IKEv2 machine certificate selection.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-Name<String>

Specifies the name of this VPN connection profile.

Alias

ConnectionName

Obligatoire ?

true

Position ?

2

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-PassThru

Retourne un objet qui représente l’élément avec lequel vous travaillez. Par défaut, cette applet de commande ne génère aucun résultat.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-PlugInApplicationID<String>

Specifies the identifier for a third party application.

Alias

none

Obligatoire ?

true

Position ?

11

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-RememberCredential

Indicates that the credentials supplied at the time of first successful connection are stored in the cache.

Alias

none

Obligatoire ?

false

Position ?

10

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-ServerAddress<String>

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.

Alias

ServerName,DefaultServer

Obligatoire ?

true

Position ?

3

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-ServerList<CimInstance[]>

Specifies an array of VPN servers. The VPN client can connect to these servers.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-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.

Alias

none

Obligatoire ?

false

Position ?

7

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-ThrottleLimit<Int32>

Spécifie le nombre maximal d’opérations simultanées qui peuvent être établies pour exécuter cette applet de commande. Si ce paramètre est omis ou si la valeur 0 est entrée, Windows PowerShell ® calcule une limitation optimale pour l’applet de commande en fonction du nombre d’applets de commande CIM qui s’exécutent sur l’ordinateur. La limitation s’applique seulement à l’applet de commande actuelle, et non pas à la session ni à l’ordinateur.

Alias

none

Obligatoire ?

false

Position ?

named

Valeur par défaut

none

Accepter l’entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-TunnelType<String>

Specifies the type of tunnel used for the VPN connection. Les valeurs acceptables pour ce paramètre sont : PPTP, L2TP, SSTP, IKEv2, or Automatic.

Alias

none

Obligatoire ?

false

Position ?

4

Valeur par défaut

Automatic

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-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.

Alias

none

Obligatoire ?

false

Position ?

11

Valeur par défaut

none

Accepter l’entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-Confirm

Votre confirmation sera requise avant l’exécution de l’applet de commande.

Obligatoire ?

false

Position ?

named

Valeur par défaut

false

Accepter l’entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-WhatIf

Présente les conséquences éventuelles de l’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Obligatoire ?

false

Position ?

named

Valeur par défaut

false

Accepter l’entrée de pipeline ?

false

Accepter les caractères génériques ?

false

<CommonParameters>

Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d’informations, consultez about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

Entrées

Le type d’entrée correspond au type des objets que vous pouvez transmettre à l’applet de commande.

Sorties

Le type de sortie est le type des objets émis par l’applet de commande.

  • Microsoft.Management.Infrastructure.CimInstance#VpnConnection

    L’objet Microsoft.Management.Infrastructure.CimInstance est une classe wrapper qui affiche des objets WMI (Windows Management Instrumentation). Le chemin d’accès situé après le symbole dièse (#) fournit l’espace de noms et le nom de classe de l’objet WMI sous-jacent.
    The VpnConnection object contains the VpnConnection configuration settings.

Exemples

Example 1: Add a VPN connection

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.

PS C:\> Add-VpnConnection -Name "Test1" -ServerAddress "10.1.1.1" -PassThru

Example 2: Add a VPN connection with an alternate authentication method

This command adds a VPN connection named Test3 to the server with an IP address 10.1.1.1. This connection uses the MSCHAPv2 authentication method, as specified by the AuthenticationMethod parameter. Additional parameters specify that the connection:

-- Uses the Windows logon credentials (the UseWinlogonCredential parameter)
-- Uses split tunneling (the SplitTunneling parameter)
-- Is stored in the global phone book (the AllUserConnection parameter)
-- Caches the credentials used for the first successful connection (the RememberCredential parameter)

By specifying the Passthru parameter, you can see the configuration of the VPN connection object.

PS C:\> Add-VpnConnection -Name "Test3" -ServerAddress "10.1.1.1" -TunnelType Pptp -EncryptionLevel Required -AuthenticationMethod MSChapv2 -UseWinlogonCredential -SplitTunneling -AllUserConnection  -RememberCredential -PassThru

Example 3: Add a VPN connection that uses EAP authentication

This command adds a VPN connection named Test4 to the server with an IP address of 10.1.1.1. This connection uses the default EAP authentication method, as specified by the AuthenticationMethod parameter. The pre-shared key for the connection is specified by the L2tpPsk parameter Additional parameters specify that the connection:

-- Uses split tunneling (the SplitTunneling parameter)
-- Is stored in the global phone book (the AllUserConnection parameter)
-- Caches the credentials used for the first successful connection (the RememberCredential parameter)

By specifying the Passthru parameter, you can see the configuration of the VPN connection object.

PS C:\> Add-VpnConnection -Name "Test4" -ServerAddress "10.1.1.1" -TunnelType L2tp -EncryptionLevel Required -AuthenticationMethod Eap -SplitTunneling -AllUserConnection -L2tpPsk "password" -Force -RememberCredential -PassThru

Example 4: Add a VPN connection that uses a custom EAP authentication method

This set of commands adds a VPN connection using a custom EAP authentication method. For more information about custom EAP authentication methods, see the New-EapConfiguration cmdlet.

This command stores the result of the New-EapConfiguration cmdlet into the variable named $A.

PS C:\> $A = New-EapConfiguration

This command adds a new VPN connection named Test5 to the server with an IP address of 10.1.1.1. This connection is configured to use the custom EAP authentication method specifying the EapConfigXmlStream parameter, and using the EapConfigXmlStream method of the $A variable created earlier. Additional parameters specify that the connection:

-- Uses split tunneling (the SplitTunneling parameter)
-- Is stored in the global phone book (the AllUserConnection parameter)
-- Caches the credentials used for the first successful connection (the RememberCredential parameter)

By specifying the Passthru parameter, you can see the configuration of the VPN connection object.

PS C:\> Add-VpnConnection -Name "Test5" -ServerAddress "10.1.1.1" -TunnelType L2tp -EncryptionLevel Required -AuthenticationMethod Eap -SplitTunneling -AllUserConnection -RememberCredential -EapConfigXmlStream $A.EapConfigXmlStream -PassThru

Rubriques connexes

Get-VpnConnection

Set-VpnConnection

Remove-VpnConnection

New-EapConfiguration