Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

SetByEncryptionType method of the PS_VpnS2SInterface class

Modifies parameters in an S2S Interface. If the interface is already connected, the changes take effect after disconnection.

Syntax


uint32 SetByEncryptionType(
  [in]   string Destination[],
  [in]   boolean AdminStatus,
  [in]   boolean PromoteAlternate,
  [in]   string AuthenticationMethod,
  [in]   string EapMethod,
  [in]   boolean InternalIPv4,
  [in]   boolean Force,
  [in]   string PostConnectionIPv4Subnet[],
  [in]   string IPv4TriggerFilter[],
  [in]   uint32 IPv4TriggerFilterAction,
  [in]   string PostConnectionIPv6Subnet[],
  [in]   string IPv6TriggerFilter[],
  [in]   uint32 IPv6TriggerFilterAction,
  [in]   string IPv4Subnet[],
  [in]   string Name,
  [in]   string ResponderAuthenticationMethod,
  [in]   boolean PassThru,
  [in]   boolean Persistent,
  [in]   boolean InitiateConfigPayload,
  [in]   string RadiusAttributeClass,
  [in]   uint32 EnableQoS,
  [in]   uint64 TxBandwidthKbps,
  [in]   uint64 RxBandwidthKbps,
  [in]   uint32 NetworkOutageTimeSeconds,
  [in]   uint32 NumberOfTries,
  [in]   uint32 RetryIntervalSeconds,
  [in]   uint32 SADataSizeForRenegotiationKilobytes,
  [in]   uint32 SALifeTimeSeconds,
  [in]   string IPv6Subnet[],
  [in]   boolean InternalIPv6,
  [in]   uint32 IdleDisconnectSeconds,
  [in]   string UserName,
  [in]   string Password,
  [in]   uint8 Certificate[],
  [in]   string SharedSecret,
  [in]   string EncryptionType,
  [in]   string SourceIpAddress,
  [out]  VpnS2SInterfaceStatistics cmdletOutput
);

Parameters

Destination [in]

Specifies the destination end-point of the S2S connection.

AdminStatus [in]

Specifies the admin status of the cmdlet.

PromoteAlternate [in]

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

AuthenticationMethod [in]

Specifies the authentication method to be used by the S2S connection.

EapMethod [in]

Specifies EAP method if IkeLocalAuthenticationMethod is EAP.

InternalIPv4 [in]

Specifies negotiation of IPv4 address.

Force [in]

Indicates whether this procedure displays the default confirmation prompt to the user. true to display the default confirmation prompt; otherwise false.

PostConnectionIPv4Subnet [in]

The IPv4 subnet to route. The routes specified by the subnet do not trigger the S2S connection.

Windows 8 and Windows Server 2012:  This parameter was renamed from IPv4DontTriggerSubnet in Windows 8.1 and Windows Server 2012 R2.

IPv4TriggerFilter [in]

An array that contains the demand dial filters for the IPv4 Transport.

IPv4TriggerFilterAction [in]

Sets the value that indicates whether the IPv4 trigger filters initiates the S2S connection. This parameter can be set to one of the following values.

ValueMeaning
0

Allow

1

Block

 

PostConnectionIPv6Subnet [in]

The IPv6 subnet to route. The routes specified by the subnet do not trigger the S2S connection.

Windows 8 and Windows Server 2012:  This parameter was renamed from IPv6DontTriggerSubnet in Windows 8.1 and Windows Server 2012 R2.

IPv6TriggerFilter [in]

An array that contains the demand dial filters for the IPv6 Transport.

IPv6TriggerFilterAction [in]

Sets the value that indicates whether the IPv6 trigger filters initiates the S2S connection. This parameter can be set to one of the following values.

ValueMeaning
0

Allow

1

Block

 

IPv4Subnet [in]

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

Name [in]

Specifies the name of the connection.

ResponderAuthenticationMethod [in]

Specifies the responder authentication method to be used by the S2S connection.

PassThru [in]

Indicates whether the cmdletOutput parameter returns an object. true to return an object other false.

Persistent [in]

A value that indicates whether the connection is persistent or triggered by network traffic. true if the connection is persistent; otherwise false.

InitiateConfigPayload [in]

A value that indicates whether negotiate the configuration with peers. true to negotiate the configuration with peers; otherwise false.

RadiusAttributeClass [in]

The Class attribute of the RADIUS server.

EnableQoS [in]

Indicates whether QoS is enabled on the network interface. 0 to enable QoS; otherwise 1.

Windows 8 and Windows Server 2012:  This parameter was renamed from QoS in Windows 8.1 and Windows Server 2012 R2.

TxBandwidthKbps [in]

The bandwidth limit for incoming traffic from the VPN interface, in kbps.

RxBandwidthKbps [in]

The bandwidth limit for outgoing traffic to the VPN interface, in kbps.

NetworkOutageTimeSeconds [in]

Maximum network outage time after which the connection is disconnected.

NumberOfTries [in]

Number of times the connection is retried. Specify 0 for an unlimited number of retries.

RetryIntervalSeconds [in]

Number of seconds between retries.

SADataSizeForRenegotiationKilobytes [in]

The number of kilobytes that are allowed to transfer using a SA. After the transfer, the SA will be renegotiated.

SALifeTimeSeconds [in]

Lifetime of a security association (SA) in seconds, after which the SA is no longer valid.

IPv6Subnet [in]

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

InternalIPv6 [in]

Specifies negotiation of IPv6 address.

IdleDisconnectSeconds [in]

A value that 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.

UserName [in]

Username to be used for dialing this connection. Applicable only if the authentication method is set to "EAP".

Password [in]

Password of the username to be used for dialing the connection. Applicable only if the authentication method is set to "EAP".

Certificate [in]

Subject Name of the certificate to be used in default store. Applicable only if the authentication method is set to "MachineCert".

SharedSecret [in]

Text of the Shared Secret to be used in dialing the connection. Applicable only if the authentication method is set to "PSK".

EncryptionType [in]

Specifies the type of encryption.

SourceIpAddress [in]

The IP address of the interface.

Windows 8 and Windows Server 2012:  This parameter is not available before Windows 8.1 and Windows Server 2012 R2.

cmdletOutput [out]

The cmdlet output.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Namespace

\root\microsoft\windows\remoteaccess

MOF

RAMgmtPSProvider.mof

DLL

RAMgmtPSProvider.dll

See also

PS_VpnS2SInterface

 

 

Community Additions

Show:
© 2014 Microsoft