VpnS2SInterface class

  • Article

Represents the S2S VPN interface.

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

Syntax

[ClassVersion("1.0.0"), dynamic, provider("RAMgmtPSProvider"), AMENDMENT]
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             IPv4TriggerFilter[];
  uint32             IPv4TriggerFilterAction;
  string             PostConnectionIPv4Subnet[];
  string             IPv6TriggerFilter[];
  uint32             IPv6TriggerFilterAction;
  string             PostConnectionIPv6Subnet[];
  boolean            Persistent;
  boolean            InitiateConfigPayload;
  uint32             EnableQoS;
  uint64             TxBandwidthKbps;
  uint64             RxBandwidthKbps;
  string             SourceIpAddress;
  uint32             MMSALifeTime;
  VpnTrafficSelector LocalVpnTrafficSelector[];
  VpnTrafficSelector RemoteVpnTrafficSelector[];
  uint32             LastDisconnectReason;
};

Members

The VpnS2SInterface class has these types of members:

Properties

The VpnS2SInterface class has these properties.

AdminStatus

Data type: boolean

Access type: Read/write

The admin status of the cmdlet.

AuthenticationMethod

Data type: string

Access type: Read/write

The authentication method to be used for the S2S connection.

The possible values are.

EAP ("EAP")

MachineCertificates ("MachineCertificates")

PSKOnly ("PSKOnly")

Certificate

Data type: uint8 array

Access type: Read/write

Subject Name of the certificate to be used in default store; applicable only when the authentication method is "MachineCert".

ConnectionState

Data type: string

Access type: Read-only

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

Destination

Data type: string array

Access type: Read/write

The destination end-point of the S2S connection.

EapMethod

Data type: string

Access type: Read/write

The EAP method when the AuthenticationMethod property is "EAP".

The possible values are:

TLS ("TLS")

PEAP ("PEAP")

MSCHAPv2 ("MSCHAPv2")

EnableQoS

Data type: uint32

Access type: Read/write

Whether QoS is enabled on the interface.

The possible values are.

0

Enabled

1

Disabled

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

IdleDisconnect

Data type: uint32

Access type: Read/write

The duration, 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: Read/write

True to negotiate the configuration with peers; otherwise false.

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

InterfaceType

Data type: string

Access type: Read/write

The type of connection.

The possible values are.

HomeRouter ("HomeRouter")

FullRouter ("FullRouter")

InternalIPv4

Data type: boolean

Access type: Read/write

true to negotiate the IPv4 address.

InternalIPv6

Data type: boolean

Access type: Read/write

true to negotiate the IPv6 address.

IPv4Subnet

Data type: string array

Access type: Read/write

The IPv4 subnet that is routed on this connection.

IPv4TriggerFilter

Data type: string array

Access type: Read/write

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

Windows Server 2012: This parameter is unavailable before Windows Server 2012 R2.

IPv4TriggerFilterAction

Data type: uint32

Access type: Read/write

Whether the IPv4 trigger filters initiates the S2S connection.

The possible values are.

0

Allow

1

Block

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

IPv6Subnet

Data type: string array

Access type: Read/write

The IPv6 subnet that is routed on this connection.

IPv6TriggerFilter

Data type: string array

Access type: Read/write

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

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

IPv6TriggerFilterAction

Data type: uint32

Access type: Read/write

Whether the IPv6 trigger filters initiates the S2S connection.

The possible values are.

0

Allow

1

Block

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

LastDisconnectReason

Data type: uint32

Access type: Read-only

The reason for the last interface disconnect.

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

LastError

Data type: uint32

Access type: Read-only

The last error value if the interface fails to connect.

LocalVpnTrafficSelector

Data type: VpnTrafficSelector array

Access type: Read-only

Qualifiers: EmbeddedInstance ("VpnTrafficSelector")

An array of local VpnTrafficSelector embedded instances to be negotiated.

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

MMSALifeTime

Data type: uint32

Access type: Read/write

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

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

Name

Data type: string

Access type: Read/write

The name of the connection.

NetworkOutageTime

Data type: uint32

Access type: Read/write

Maximum network outage time after which the connection is disconnected.

NumberOfTries

Data type: uint32

Access type: Read/write

Number of times the connection is retried.

Persistent

Data type: boolean

Access type: Read/write

True if the connection is persistent; otherwise false.

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

PostConnectionIPv4Subnet

Data type: string array

Access type: Read/write

The IPv4 subnet to route

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

Windows Server 2012: This property was renamed from IPv4DontTriggerSubnet in Windows Server 2012 R2.

PostConnectionIPv6Subnet

Data type: string array

Access type: Read/write

The IPv6 subnet to route

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

Windows Server 2012: This property was renamed from IPv6DontTriggerSubnet in Windows Server 2012 R2.

PromoteAlternate

Data type: boolean

Access type: Read-only

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

Protocol

Data type: string

Access type: Read/write

The underlying protocol.

The possible values are.

L2TP ("L2TP")

IKEv2 ("IKEv2")

Automatic ("Automatic")

GRE ("GRE")

Windows Server 2012 and Windows Server 2012 R2: The "GRE" value is not supported before Windows Server 2016.

RemoteVpnTrafficSelector

Data type: VpnTrafficSelector array

Access type: Read-only

Qualifiers: EmbeddedInstance ("VpnTrafficSelector")

An array of remote VpnTrafficSelector embedded instances to be negotiated.

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

ResponderAuthenticationMethod

Data type: string

Access type: Read/write

The responder authentication method to be used for the S2S connection.

The possible values are.

MachineCertificates ("MachineCertificates")

PSKOnly ("PSKOnly")

RetryInterval

Data type: uint32

Access type: Read/write

Number of seconds between retries.

RxBandwidthKbps

Data type: uint64

Access type: Read/write

The incoming bandwidth limit of the interface.

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

SADataSizeForRenegotiation

Data type: uint32

Access type: Read/write

The number of kilobytes that can be transferred using a security administration (SA). After the transfer, the SA will be renegotiated.

SALifeTime

Data type: uint32

Access type: Read/write

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

SourceIpAddress

Data type: string

Access type: Read/write

The IP address of the interface.

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

TxBandwidthKbps

Data type: uint64

Access type: Read/write

The outgoing bandwidth limit of the interface.

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

UnReachabilityReasons

Data type: string

Access type: Read-only

The reason why the interface was unreachable.

UserName

Data type: string

Access type: Read/write

The username to use for dialing this connection when the authentication method is set to "EAP".

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2012
Namespace
 Root\Microsoft\Windows\RemoteAccess
MOF
RAMgmtPSProvider.mof
DLL
RAMgmtPSProvider.dll