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.

VpnS2SInterface class

Represents the S2S VPN interface.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Dynamic, Provider("RAMgmtPSProvider")]class VpnS2SInterface
{
  string  Protocol;
  string  Destination[];
  boolean AdminStatus;
  string  InterfaceType;
  uint32  RetryInterval;
  uint32  SADataSizeForRenegotiation;
  uint32  SALifeTime;
  string  IPv6Subnet[];
  string  IPv4Subnet[];
  string  Name;
  string  UserName;
  uint8   Certificate[];
  uint32  NetworkOutageTime;
  uint32  NumberOfTries;
  boolean PromoteAlternate;
  string  AuthenticationMethod;
  string  ResponderAuthenticationMethod;
  string  EapMethod;
  boolean InternalIPv4;
  boolean InternalIPv6;
  uint32  IdleDisconnect;
  uint32  LastError;
  string  UnReachabilityReasons;
  string  ConnectionState;
  string  IPv6TriggerFilter[];
  uint32  IPv4TriggerFilterAction;
  string  PostConnectionIPv4Subnet[];
  string  IPv6TriggerFilter[];
  uint32  IPv6TriggerFilterAction;
  string  PostConnectionIPv6Subnet[];
  boolean Persistent;
  boolean InitiateConfigPayload;
  uint32  EnableQoS;
  uint64  TxBandwidthKbps;
  uint64  RxBandwidthKbps;
  string  SourceIpAddress;
};

Members

The VpnS2SInterface class has these types of members:

Properties

The VpnS2SInterface class has these properties.

AdminStatus
Data type: boolean
Access type: Write-only

Specifies the admin status of the cmdlet.

AuthenticationMethod
Data type: string
Access type: Write-only

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

EAP ("EAP")
MachineCertificates ("MachineCertificates")
PSKOnly ("PSKOnly")
Certificate
Data type: uint8 array
Access type: Write-only

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

ConnectionState
Data type: string
Access type: Read-only

Specifies the current state of the interface, for example connected, disconnected, or unreachable.

Destination
Data type: string array
Access type: Write-only

Specifies the destination end-point of the S2S connection.

EapMethod
Data type: string
Access type: Write-only

Specifies EAP method if IkeLocalAuthenticationMethod is EAP.

TLS ("TLS")
PEAP ("PEAP")
MSCHAPv2 ("MSCHAPv2")
EnableQoS
Data type: uint32
Access type: Write-only

Sets a value that indicates whether QoS is enabled on the interface. This parameter can be set to one of the following values.

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

ValueMeaning
0

Enabled

1

Disabled

 

IdleDisconnect
Data type: uint32
Access type: Write-only

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

InitiateConfigPayload
Data type: boolean
Access type: Write-only

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

InterfaceType
Data type: string
Access type: Write-only

Specifies type of connection.

HomeRouter ("HomeRouter")
FullRouter ("FullRouter")
InternalIPv4
Data type: boolean
Access type: Write-only

Specifies negotiation of IPv4 address.

InternalIPv6
Data type: boolean
Access type: Write-only

Specifies negotiation of IPv6 address.

IPv4Subnet
Data type: string array
Access type: Write-only

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

IPv4TriggerFilterAction
Data type: uint32
Access type: Write-only

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.

Windows 8 and Windows Server 2012:  The data type of this property was changed from a string in Windows 8.1 and Windows Server 2012 R2.

ValueMeaning
0

Allow

1

Block

 

IPv6Subnet
Data type: string array
Access type: Write-only

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

IPv6TriggerFilter
Data type: string array
Access type: Write-only

Sets and array that contains the demand dial filters for the IPv4 Transport.

IPv6TriggerFilter
Data type: string array
Access type: Write-only

Sets and array that contains the demand dial filters for the IPv6 Transport.

IPv6TriggerFilterAction
Data type: uint32
Access type: Write-only

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.

Windows 8 and Windows Server 2012:  The data type of this property was changed from a string in Windows 8.1 and Windows Server 2012 R2.

ValueMeaning
0

Allow

1

Block

 

LastError
Data type: uint32
Access type: Read-only

Specifies a nonzero value if the interface fails to connect.

Name
Data type: string
Access type: Write-only

Specifies the name of the connection.

NetworkOutageTime
Data type: uint32
Access type: Write-only

Maximum network outage time after which the connection is disconnected.

NumberOfTries
Data type: uint32
Access type: Write-only

Number of tries the connection is retried.

Persistent
Data type: boolean
Access type: Write-only

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

PostConnectionIPv4Subnet
Data type: string array
Access type: Write-only

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

Windows 8 and Windows Server 2012:  This property was renamed from IPv4DontTriggerSubnetWindows 8.1 and Windows Server 2012 R2.

PostConnectionIPv6Subnet
Data type: string array
Access type: Write-only

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

Windows 8 and Windows Server 2012:  This property was renamed from IPv6DontTriggerSubnetWindows 8.1 and Windows Server 2012 R2.

PromoteAlternate
Data type: boolean
Access type: Read-only

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.

Protocol
Data type: string
Access type: Write-only

Specifies the underlying protocol.

L2TP ("L2TP")
IKEv2 ("IKEv2")
Automatic ("Automatic")
ResponderAuthenticationMethod
Data type: string
Access type: Write-only

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

MachineCertificates ("MachineCertificates")
PSKOnly ("PSKOnly")
RetryInterval
Data type: uint32
Access type: Write-only

Number of seconds between retries.

RxBandwidthKbps
Data type: uint64
Access type: Write-only

Sets the incoming bandwidth limit of the interface.

SADataSizeForRenegotiation
Data type: uint32
Access type: Write-only

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

SALifeTime
Data type: uint32
Access type: Write-only

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

SourceIpAddress
Data type: string
Access type: Write-only

Sets the IP address of the interface.

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

TxBandwidthKbps
Data type: uint64
Access type: Write-only

Sets the outgoing bandwidth limit of the interface.

UnReachabilityReasons
Data type: string
Access type: Read-only

Specifies a value that represents a reason why the interface was unreachable.

UserName
Data type: string
Access type: Write-only

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

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Namespace

\root\microsoft\windows\remoteaccess

MOF

RAMgmtPSProvider.mof

DLL

RAMgmtPSProvider.dll

 

 

Community Additions

Show:
© 2014 Microsoft