COMMAND EVERYTHING.

Set-VpnS2SInterface

Updates parameters for an S2S Interface.

Networking / Security · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft RemoteAccess reference: Updates parameters for an S2S Interface. 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.

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

Copied 0 times

Required permissions

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

Supported environments

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

Parameters

-AdminStatus: Specifies the admin status of the cmdlet.
-AsJob: Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
-AuthenticationMethod: Specifies the AuthenticationMethod to be used by the S2S connection.
-AuthenticationTransformConstants: Specifies the authentication transform plumbed in IPsec policy.
-AutoConnectEnabled: Specifies a value that indicates whether auto-connect is enabled.
-Certificate: Specifies the subject name of the certificate to be used in default store. This parameter is applicable only if the *AuthenticationMethod* parameter is set to MachineCert.
-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.
-CipherTransformConstants: Specifies the cipher plumbed in IPsec policy.
-Confirm: Prompts you for confirmation before running the cmdlet.
-CustomPolicy (required): Specifies custom Internet Key Exchange (IKE) IPsec policies, must be a separate parameter set.
-DHGroup: Specifies the Diffie-Hellman (DH) Group Plumbed in IPsec policy.
-Destination: Specifies the destination end-point of the S2S connection.
-EapMethod: Specifies EAP method if IkeLocalAuthenticationMethod is EAP.
-EnableQoS: Indicates whether to enable Quality of Service (QoS) on an interface. The acceptable values for this parameter are: - Enabled - Disabled
-EncryptionMethod: Specifies the encryption method plumbed in IKE policy.
-EncryptionType: Specifies the type of Encryption.
-Force: Forces the command to run without asking for user confirmation.
-GreKey: Specifies the individual traffic flows within a Generic Routing Encapsulation (GRE) tunnel.

Prerequisites

Windows with the RemoteAccess 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: Modify the destination address of an interface

Set-VpnS2SInterface -Name "Edge1" -Destination 131.107.0.4 -PassThru

This command modifies the destination address of interface named Edge1. 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/RemoteAccess/Set-VpnS2SInterface.md

https://learn.microsoft.com/powershell/module/remoteaccess/set-vpns2sinterface?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands

Get-NetIPInterface

Add-MpPreference

Get-MpPerformanceReport

Add-DhcpServerInDC