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]
   [-AutoConnectEnabled <Boolean>]
   [-InitiateConfigPayload <Boolean>]
   [-RadiusAttributeClass <String>]
   [-EnableQoS <EnableQoS>]
   [-TxBandwidthKbps <UInt64>]
   [-RxBandwidthKbps <UInt64>]
   [-NetworkOutageTimeSeconds <UInt32>]
   [-NumberOfTries <UInt32>]
   [-RetryIntervalSeconds <UInt32>]
   [-SADataSizeForRenegotiationKilobytes <UInt32>]
   [-SALifeTimeSeconds <UInt32>]
   [-MMSALifeTimeSeconds <UInt32>]
   [-IPv6Subnet <String[]>]
   [-InternalIPv6 <Boolean>]
   [-IdleDisconnectSeconds <UInt32>]
   [-UserName <String>]
   [-Password <String>]
   [-Certificate <X509Certificate2>]
   [-SharedSecret <String>]
   [-SourceIpAddress <String>]
   [-LocalVpnTrafficSelector <CimInstance[]>]
   [-RemoteVpnTrafficSelector <CimInstance[]>]
   [-EncryptionType <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-VpnS2SInterface
   [[-Destination] <String[]>]
   [-AdminStatus <Boolean>]
   [-InternalIPv4 <Boolean>]
   [-Force]
   [-IPv4Subnet <String[]>]
   [-Name] <String>
   [-PassThru]
   [-EnableQoS <EnableQoS>]
   [-TxBandwidthKbps <UInt64>]
   [-RxBandwidthKbps <UInt64>]
   [-IPv6Subnet <String[]>]
   [-InternalIPv6 <Boolean>]
   [-SourceIpAddress <String>]
   [[-GreKey] <UInt32>]
   [-GreTunnel]
   [-IPv4Address <String>]
   [-IPv6Address <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]
   [-AutoConnectEnabled <Boolean>]
   [-InitiateConfigPayload <Boolean>]
   [-RadiusAttributeClass <String>]
   [-EnableQoS <EnableQoS>]
   [-TxBandwidthKbps <UInt64>]
   [-RxBandwidthKbps <UInt64>]
   [-NetworkOutageTimeSeconds <UInt32>]
   [-NumberOfTries <UInt32>]
   [-RetryIntervalSeconds <UInt32>]
   [-SADataSizeForRenegotiationKilobytes <UInt32>]
   [-SALifeTimeSeconds <UInt32>]
   [-MMSALifeTimeSeconds <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>]
   [-LocalVpnTrafficSelector <CimInstance[]>]
   [-RemoteVpnTrafficSelector <CimInstance[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-VpnS2SInterace cmdlet is used to update parameters for a site-to-site (S2S) interface. If the connection is already connected, the changes take effect after disconnection. You can use the CustomPolicy parameter to customize Internet Protocol security (IPSec) settings. 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 authentication method is pre shared key, the interface whose destination IP matches the incoming IP is activated.
• If the authentication method is username, the interface whose name matches the username is activated.
• If the authentication method is certificates the interface whose name matches the certificate subject name is activated.

This cmdlet is used to modify parameters a S2S Interface. If the connection is already connected, the changes take effect after disconnection.

Examples

Example 1: Modify the destination address of an interface

PS C:\>Set-VpnS2SInterface -Name "Edge1" -Destination 131.107.0.4 -PassThru

This command modifies the destination address of interface named Edge1.

Example 2: Modify the initiator authentication method

PS C:\>Set-VpnS2SInterface -Name "Edge1" -AuthenticationMethod EAP -EapMethod EAP-MSCHAPv2 -PassThru

This command modifies the initiator authentication method.

Example 3: Modify the configuration of an existing S2S VPN interface

PS C:\>Set-VpnS2SInterface -Name "Edge1" -IPv4Subnet 172.23.90.0/24:50 -PassThru
RoutingDomain   Name                 Destination          AdminStatus  ConnectionState IPv4Subnet
-------------   ----                 -----------          -----------  --------------- ----------
Rd_001          Blue-Tunnel-2        {100.0.0.7}          True         Disconnected    {172.23.90.0/24:50}

This command modifies the configuration of an existing S2S VPN interface of a specific routing domain in a Multi-Tenant environment.

Required Parameters

Optional Parameters

Outputs

Microsoft.Management.Infrastructure.CimInstance#VpnS2SInterface

Related Links

• Add-VpnS2SInterface
• Connect-VpnS2SInterface
• Disconnect-VpnS2SInterface
• Get-VpnS2SInterface
• Remove-VpnS2SInterface
• Remote Access Cmdlets