Set-VpnS2SInterface

Syntax

Set-VpnS2SInterface
   [-Destination <String[]>]
   [-AdminStatus <Boolean>]
   [-PromoteAlternate <Boolean>]
   [-AuthenticationMethod <String>]
   [-EapMethod <String>]
   [-InternalIPv4 <Boolean>]
   [-Force]
   [-PostConnectionIPv4Subnet <String[]>]
   [-IPv4TriggerFilter <String[]>]
   [-IPv4TriggerFilterAction <Action>]
   [-PostConnectionIPv6Subnet <String[]>]
   [-IPv6TriggerFilter <String[]>]
   [-IPv6TriggerFilterAction <Action>]
   [-IPv4Subnet <String[]>]
   [-Name] <String>
   [-ResponderAuthenticationMethod <String>]
   [-PassThru]
   [-Persistent]
   [-InitiateConfigPayload <Boolean>]
   [-RadiusAttributeClass <String>]
   [-EnableQoS <EnableQoS>]
   [-TxBandwidthKbps <UInt64>]
   [-RxBandwidthKbps <UInt64>]
   [-NetworkOutageTimeSeconds <UInt32>]
   [-NumberOfTries <UInt32>]
   [-RetryIntervalSeconds <UInt32>]
   [-SADataSizeForRenegotiationKilobytes <UInt32>]
   [-SALifeTimeSeconds <UInt32>]
   [-IPv6Subnet <String[]>]
   [-InternalIPv6 <Boolean>]
   [-IdleDisconnectSeconds <UInt32>]
   [-UserName <String>]
   [-Password <String>]
   [-Certificate <X509Certificate2>]
   [-SharedSecret <String>]
   [-SourceIpAddress <String>]
   [-EncryptionType <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-VpnS2SInterface
   [-Destination <String[]>]
   [-AdminStatus <Boolean>]
   [-PromoteAlternate <Boolean>]
   [-AuthenticationMethod <String>]
   [-EapMethod <String>]
   [-InternalIPv4 <Boolean>]
   [-Force]
   [-PostConnectionIPv4Subnet <String[]>]
   [-IPv4TriggerFilter <String[]>]
   [-IPv4TriggerFilterAction <Action>]
   [-PostConnectionIPv6Subnet <String[]>]
   [-IPv6TriggerFilter <String[]>]
   [-IPv6TriggerFilterAction <Action>]
   [-IPv4Subnet <String[]>]
   [-Name] <String>
   [-ResponderAuthenticationMethod <String>]
   [-PassThru]
   [-Persistent]
   [-InitiateConfigPayload <Boolean>]
   [-RadiusAttributeClass <String>]
   [-EnableQoS <EnableQoS>]
   [-TxBandwidthKbps <UInt64>]
   [-RxBandwidthKbps <UInt64>]
   [-NetworkOutageTimeSeconds <UInt32>]
   [-NumberOfTries <UInt32>]
   [-RetryIntervalSeconds <UInt32>]
   [-SADataSizeForRenegotiationKilobytes <UInt32>]
   [-SALifeTimeSeconds <UInt32>]
   [-IPv6Subnet <String[]>]
   [-InternalIPv6 <Boolean>]
   [-IdleDisconnectSeconds <UInt32>]
   [-UserName <String>]
   [-Password <String>]
   [-Certificate <X509Certificate2>]
   [-SharedSecret <String>]
   [-EncryptionMethod <EncryptionMethod>]
   [-IntegrityCheckMethod <IntegrityCheckMethod>]
   [-CipherTransformConstants <CipherTransformConstants>]
   [-DHGroup <DHGroup>]
   [-AuthenticationTransformConstants <AuthenticationTransformConstants>]
   [-PfsGroup <PfsGroup>]
   [-CustomPolicy]
   [-SourceIpAddress <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-VpnS2SInterface cmdlet modifies parameters for a site-to-site (S2S) interface. If the connection already exists, then the changes take effect after disconnection.

Use the CustomPolicy parameter to customize IPsec settings. If the protocol is Automatic, then the only authentication method allowed is user name. If the AuthenticationMethod parameter is set to pre-shared key (PSK), then only one interface can be enabled per destination and the initiator and responder policies are governed by what is specified for each interface. If the AuthenticationMethod parameter is set to user name or computer certificates (machine certificates), then only the initiator policies are governed by what is specified for each interface and the responder policies are governed by what is specified on the server.

For incoming connections.

-- If the AuthenticationMethod parameter is set to PSK, then the interface for which the destination IP address matches the incoming IP address is activated.

-- If the AuthenticationMethod parameter is set to user name, then the interface for which the name matches the user name is activated.

-- If the AuthenticationMethod parameter is certificates, then the interface for which the name matches the certificate subject name is activated.

Examples

EXAMPLE 1

PS C:\> Set-VpnS2SInterface -Name edge1 -Destination 131.107.0.4 -PassThru
Name                 Destination          AdminStatus  ConnectionState IPv4Subnet 
----                 -----------          -----------  --------------- ---------- 
edge1                {131.107.0.4}        True         Disconnected    {10.0.0.0/24:100}

This example modifies the destination address for the interface named edge1.

EXAMPLE 2

PS C:\>Set-VpnS2SInterface -Name edge1 -AuthenticationMethod EAP -EapMethod EAP-MSCHAPv2 -PassThru
Name                 Destination          AdminStatus  ConnectionState IPv4Subnet 
----                 -----------          -----------  --------------- ---------- 
EDGE1                {131.107.0.4}        True         Disconnected    {10.0.0.0/24:100}

This example modifies the initiator authentication method.

EXAMPLE 3

PS C:\>Get-VpnS2SInterface -Name edge1 | Set-VpnS2SInterface -ResponderAuthenticationMethod MachineCertificates -PassThru
Name                 Destination          AdminStatus  ConnectionState IPv4Subnet 
----                 -----------          -----------  --------------- ---------- 
EDGE1                {131.107.0.4}        True         Disconnected    {10.0.0.0/24:100}

This example modifies the responder authentication method for edge1.

EXAMPLE 4

PS C:\>$cert1 = ( Get-ChildItem -Path cert:LocalMachine\My | Where-Object -FilterScript { $_.Subject -Like "*CN=edge1.contoso.com" } )



PS C:\>Set-VpnS2SInterface -Name 3-edge1 -AuthenticationMethod MachineCertificates -Certificate $cert1 -ResponderAuthenticationMethod MachineCertificates -PassThru
Name                 Destination          AdminStatus  ConnectionState IPv4Subnet 
----                 -----------          -----------  --------------- ---------- 
3-edge1              {131.107.0.30}       True         Disconnected    {10.6.0.0/24:2}

This example changes the authentication method for the interface 3-edge1 to computer certificate and specifies the certificate for which the subject name matches edge1.contoso.com.

Parameters

-AdminStatus

-AsJob

-AuthenticationMethod

-AuthenticationTransformConstants

-Certificate

-CimSession

-CipherTransformConstants

-Confirm

-CustomPolicy

-Destination

-DHGroup

-EapMethod

-EnableQoS

-EncryptionMethod

-EncryptionType

-Force

-IdleDisconnectSeconds

-InitiateConfigPayload

-IntegrityCheckMethod

-InternalIPv4

-InternalIPv6

-IPv4Subnet

-IPv4TriggerFilter

-IPv4TriggerFilterAction

-IPv6Subnet

-IPv6TriggerFilter

-IPv6TriggerFilterAction

-Name

-NetworkOutageTimeSeconds

-NumberOfTries

-PassThru

-Password

-Persistent

-PfsGroup

-PostConnectionIPv4Subnet

-PostConnectionIPv6Subnet

-PromoteAlternate

-RadiusAttributeClass

-ResponderAuthenticationMethod

-RetryIntervalSeconds

-RxBandwidthKbps

-SADataSizeForRenegotiationKilobytes

-SALifeTimeSeconds

-SharedSecret

-SourceIpAddress

-ThrottleLimit

-TxBandwidthKbps

-UserName

-WhatIf

Inputs

None

Outputs

CimInstance

The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Related Links

• Add-VpnS2SInterface
• Clear-VpnS2SInterfaceStatistics
• Connect-VpnS2SInterface
• Disconnect-VpnS2SInterface
• Get-VpnAuthProtocol
• Get-VpnS2SInterface
• Get-VpnS2SInterfaceStatistics
• Remove-VpnS2SInterface
• Set-VpnAuthProtocol