Edit

Share via

Set-VpnS2SInterface

Module:
RemoteAccess Module

Updates parameters for an S2S Interface.

Syntax

EncryptionType (Default) 

Set-VpnS2SInterface
    [[-Destination] <String[]>]
    [-Name] <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[]>]
    [-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>]

GreInterface 

Set-VpnS2SInterface
    [[-Destination] <String[]>]
    [-Name] <String>
    [[-GreKey] <UInt32>]
    [-AdminStatus <Boolean>]
    [-InternalIPv4 <Boolean>]
    [-Force]
    [-IPv4Subnet <String[]>]
    [-PassThru]
    [-EnableQoS <EnableQoS>]
    [-TxBandwidthKbps <UInt64>]
    [-RxBandwidthKbps <UInt64>]
    [-IPv6Subnet <String[]>]
    [-InternalIPv6 <Boolean>]
    [-SourceIpAddress <String>]
    [-GreTunnel]
    [-IPv4Address <String>]
    [-IPv6Address <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CustomPolicy 

Set-VpnS2SInterface
    [[-Destination] <String[]>]
    [-Name] <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[]>]
    [-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.

Parameters

-AdminStatus

Specifies the admin status of the cmdlet.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AuthenticationMethod

Specifies the AuthenticationMethod to be used by the S2S connection.

Parameter properties

Type:String
Default value:None
Accepted values:EAP, MachineCertificates, PSKOnly, MSCHAPv2
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-AuthenticationTransformConstants

Specifies the authentication transform plumbed in IPsec policy.

Parameter properties

Type:AuthenticationTransformConstants
Default value:None
Accepted values:MD596, SHA196, SHA256128, GCMAES128, GCMAES192, GCMAES256, None
Supports wildcards:False
DontShow:False
Aliases:FirstTransformType, AuthenticationTransformConstant

Parameter sets

CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-AutoConnectEnabled

Specifies a value that indicates whether auto-connect is enabled.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

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

Parameter properties

Type:X509Certificate2
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Cert

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CipherTransformConstants

Specifies the cipher plumbed in IPsec policy.

Parameter properties

Type:CipherTransformConstants
Default value:None
Accepted values:DES, DES3, AES128, AES192, AES256, GCMAES128, GCMAES192, GCMAES256, None
Supports wildcards:False
DontShow:False
Aliases:OtherCipherAlgorithm, FirstCipherAlgorithm, CipherTransformConstant

Parameter sets

CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CustomPolicy

Specifies custom Internet Key Exchange (IKE) IPsec policies, must be a separate parameter set.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CustomPolicy
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Destination

Specifies the destination end-point of the S2S connection.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:RemoteTunnelEndpoint, RemoteTunnelHostname, RemoteAddress

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DHGroup

Specifies the Diffie-Hellman (DH) Group Plumbed in IPsec policy.

Parameter properties

Type:DHGroup
Default value:None
Accepted values:None, Group1, Group2, Group14, ECP256, ECP384, Group24
Supports wildcards:False
DontShow:False

Parameter sets

CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-EapMethod

Specifies EAP method if IkeLocalAuthenticationMethod is EAP.

Parameter properties

Type:String
Default value:None
Accepted values:EAP-TLS, EAP-PEAP, EAP-MSCHAPv2
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-EnableQoS

Indicates whether to enable Quality of Service (QoS) on an interface. The acceptable values for this parameter are:

  • Enabled
  • Disabled

Parameter properties

Type:EnableQoS
Default value:None
Accepted values:Disabled, Enabled
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-EncryptionMethod

Specifies the encryption method plumbed in IKE policy.

Parameter properties

Type:EncryptionMethod
Default value:None
Accepted values:DES, DES3, AES128, AES192, AES256
Supports wildcards:False
DontShow:False
Aliases:Encryption

Parameter sets

CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-EncryptionType

Specifies the type of Encryption.

Parameter properties

Type:String
Default value:None
Accepted values:NoEncryption, RequireEncryption, OptionalEncryption, MaximumEncryption, CustomEncryption
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-GreKey

Specifies the individual traffic flows within a Generic Routing Encapsulation (GRE) tunnel.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GreInterface
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-GreTunnel

Indicates that this cmdlet uses the GRE tunnel capability for the Windows Server Gateway.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GreInterface
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IdleDisconnectSeconds

Specifies the time, in seconds, after which an idle connection is terminated. Unless the idle time-out is disabled, the entire connection is terminated if the connection is idle for the specified interval.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:IdleDurationSeconds, IdleDisconnectSec

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-InitiateConfigPayload

Indicates whether to initiate a config payload negotiation.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-IntegrityCheckMethod

Specifies the integrity method plumbed in IPsec policy.

Parameter properties

Type:IntegrityCheckMethod
Default value:None
Accepted values:MD5, SHA1, SHA256, SHA384
Supports wildcards:False
DontShow:False
Aliases:FirstIntegrityAlgorithm, OtherHashAlgorithm

Parameter sets

CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-InternalIPv4

Specifies that the IPv4 address should be negotiated.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-InternalIPv6

Specifies that the Ipv6 address should be negotiated.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-IPv4Address

Specifies the IPv4 address.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GreInterface
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-IPv4Subnet

Specifies the IPv4 subnet that is routed on this connection with metric.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:IPv4TriggerSubnet

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-IPv4TriggerFilter

Specifies an array of IPv4 filters that trigger demand dial connections.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-IPv4TriggerFilterAction

Indicates whether a filter should trigger an S2S connection.

Parameter properties

Type:Action
Default value:None
Accepted values:Allow, Deny
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-IPv6Address

Specifies the IPv6 address.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GreInterface
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-IPv6Subnet

Specifies the IPv6 subnet that is routed on this connection with metric.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:IPv6TriggerSubnet

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-IPv6TriggerFilter

Specifies an array of IPv6 filters that trigger demand dial connections.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-IPv6TriggerFilterAction

Indicates whether a filter should trigger an S2S connection.

Parameter properties

Type:Action
Default value:None
Accepted values:Allow, Deny
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-LocalVpnTrafficSelector

Specifies the traffic selector object.

Parameter properties

Type:

CimInstance[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-MMSALifeTimeSeconds

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.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:MMSaLifeTimeSec

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Name

Specifies the name of the connection.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ElementName

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-NetworkOutageTimeSeconds

Specifies the maximum network outage time after which the connection is disconnected.

Parameter properties

Type:UInt32
Default value:None
Accepted values:3, 6, 9, 12, 15, 30, 60, 120, 240, 360, 720, 900
Supports wildcards:False
DontShow:False
Aliases:NetworkOutageTimeSec

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-NumberOfTries

Specifies the number of tries the connection is retried. If you specify 0, the cmdlet will retry indefinitely.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Password

Specifies the password of the username to be used for dialing the connection. This parameter is only applicable if AuthenticationMethod is set to EAP.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Persistent

Indicates whether the connection state is persisted across the service restart or system reboots.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PfsGroup

Specifies the perfect forward secrecy (PFS) Group plumbed in IPsec policy.

Parameter properties

Type:PfsGroup
Default value:None
Accepted values:None, PFS1, PFS2, PFS2048, ECP256, ECP384, PFSMM, PFS24
Supports wildcards:False
DontShow:False
Aliases:PfsGroupId

Parameter sets

CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PostConnectionIPv4Subnet

Specifies the IPv4 subnet routes that are added to a S2S interface after the connection is established. The values specified are not used to initiate the S2S VPN connection.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PostConnectionIPv6Subnet

Specifies the IPv6 subnet routes that are added to a S2S interface after the connection is established. The values specified are not used to initiate the S2S VPN connection.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PromoteAlternate

Specifies an alternate IP address that when it successfully connects becomes the primary IP address, and the current primary IP address is moved to the alternate list.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-RadiusAttributeClass

Specifies a RADIUS attribute.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-RemoteVpnTrafficSelector

Specifies the traffic selector object.

Parameter properties

Type:

CimInstance[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ResponderAuthenticationMethod

Specifies the responder AuthenticationMethod to be used by the S2S connection.

Parameter properties

Type:String
Default value:None
Accepted values:MachineCertificates, PSKOnly
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-RetryIntervalSeconds

Specifies the number of seconds between retries.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RetryIntervalSec

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-RxBandwidthKbps

Specifies the receive bandwidth limit, in kilobits per second (Kbps).

Parameter properties

Type:UInt64
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-SADataSizeForRenegotiationKilobytes

Specifies the number of kilobytes that are allowed to transfer using a security association (SA), after which the SA will be renegotiated.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SARenegotiationDataSizeKB, LifeTimeKiloBytes

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-SALifeTimeSeconds

Specifies the lifetime of a SA in seconds, after which the SA is no longer valid.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SaLifeTimeSec, LifeTimeSeconds, QMSALifeTimeSeconds

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-SharedSecret

Specifies the text of the shared secret to be used in dialing the connection. This parameter is only applicable if AuthenticationMethod is set to PSK.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SourceIpAddress

Specifies the source IPv4 or IPv6 addresses to use when dialing the connection.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ThrottleLimit

Specifies the maximum number of concurrent connections that can be established to run this command. If you omit this parameter or enter a value of 0, the default value, 32, is used.

The throttle limit applies only to the current command, not to the session or to the computer.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TxBandwidthKbps

Specifies a transmit bandwidth limit, in Kbps, for the interface.

Parameter properties

Type:UInt64
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-UserName

Specifies the username to be used for dialing this connection. This parameter is only applicable if AuthenticationMethod is set to EAP.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:User

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Boolean

String

Nullable<T>

SwitchParameter

Nullable<T>

Nullable<T>

UInt32

Microsoft.PowerShell.Cmdletization.GeneratedTypes.VpnS2SInterface.EncryptionMethod

Microsoft.PowerShell.Cmdletization.GeneratedTypes.VpnS2SInterface.IntegrityCheckMethod

Microsoft.PowerShell.Cmdletization.GeneratedTypes.VpnS2SInterface.CipherTransformConstants

Microsoft.PowerShell.Cmdletization.GeneratedTypes.VpnS2SInterface.DHGroup

Microsoft.PowerShell.Cmdletization.GeneratedTypes.VpnS2SInterface.AuthenticationTransformConstants

Microsoft.PowerShell.Cmdletization.GeneratedTypes.VpnS2SInterface.PfsGroup

CimInstance

Nullable<T>

Outputs

CimInstance

CimInstance