Windows Dev Center

Expand Minimize

VpnS2SDefaultInterface class

Represents the S2S VPN default interface.

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

Syntax

[Dynamic, Provider("RAMgmtPSProvider"), ClassVersion("1.0.0"), AMENDMENT]class VpnS2SDefaultInterface : 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;
  string  EncryptionType;
};

Members

The VpnS2SDefaultInterface class has these types of members:

Properties

The VpnS2SDefaultInterface class has these properties.

AdminStatus
Data type: boolean
Access type: Read/write

Specifies the admin status of the cmdlet.

This property is inherited from VpnS2SInterface.

AuthenticationMethod
Data type: string
Access type: Read/write

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

This property is inherited from VpnS2SInterface.

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 if the AuthenticationMethod property is set to "MachineCert".

This property is inherited from VpnS2SInterface.

ConnectionState
Data type: string
Access type: Read-only

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

This property is inherited from VpnS2SInterface.

Destination
Data type: string array
Access type: Read/write

Specifies the destination end-point of the S2S connection.

This property is inherited from VpnS2SInterface.

EapMethod
Data type: string
Access type: Read/write

Specifies EAP method if the AuthenticationMethod property is "EAP".

This property is inherited from VpnS2SInterface.

TLS ("TLS")
PEAP ("PEAP")
MSCHAPv2 ("MSCHAPv2")
EnableQoS
Data type: uint32
Access type: Read/write

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

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

This property is inherited from VpnS2SInterface.

ValueMeaning
0

Enabled

1

Disabled

 

EncryptionType
Data type: string
Access type: Read/write

Specifies the type of encryption.

NoEncryption ("NoEncryption")
RequireEncryption ("RequireEncryption")
OptionalEncryption ("OptionalEncryption")
MaximumEncryption ("MaximumEncryption")
IdleDisconnect
Data type: uint32
Access type: Read/write

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.

This property is inherited from VpnS2SInterface.

InitiateConfigPayload
Data type: boolean
Access type: Read/write

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

This property is inherited from VpnS2SInterface.

InterfaceType
Data type: string
Access type: Read/write

Specifies type of connection.

This property is inherited from VpnS2SInterface.

HomeRouter ("HomeRouter")
FullRouter ("FullRouter")
InternalIPv4
Data type: boolean
Access type: Read/write

Specifies negotiation of IPv4 address.

This property is inherited from VpnS2SInterface.

InternalIPv6
Data type: boolean
Access type: Read/write

Specifies negotiation of IPv6 address.

This property is inherited from VpnS2SInterface.

IPv4Subnet
Data type: string array
Access type: Read/write

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

This property is inherited from VpnS2SInterface.

IPv4TriggerFilter
Data type: string array
Access type: Read/write

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

This property is inherited from VpnS2SInterface.

IPv4TriggerFilterAction
Data type: uint32
Access type: Read/write

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 Server 2012:  The data type of this property was changed from a string in Windows Server 2012 R2.

This property is inherited from VpnS2SInterface.

ValueMeaning
0

Allow

1

Block

 

IPv6Subnet
Data type: string array
Access type: Read/write

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

This property is inherited from VpnS2SInterface.

IPv6TriggerFilter
Data type: string array
Access type: Read/write

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

This property is inherited from VpnS2SInterface.

IPv6TriggerFilterAction
Data type: uint32
Access type: Read/write

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 Server 2012:  The data type of this property was changed from a string in Windows Server 2012 R2.

This property is inherited from VpnS2SInterface.

ValueMeaning
0

Allow

1

Block

 

LastError
Data type: uint32
Access type: Read-only

Specifies a nonzero value if the interface fails to connect.

This property is inherited from VpnS2SInterface.

MMSALifeTime
Data type: uint32
Access type: Read/write

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

This property is inherited from VpnS2SInterface.

Name
Data type: string
Access type: Read/write

Specifies the name of the connection.

This property is inherited from VpnS2SInterface.

NetworkOutageTime
Data type: uint32
Access type: Read/write

Maximum network outage time after which the connection is disconnected.

This property is inherited from VpnS2SInterface.

NumberOfTries
Data type: uint32
Access type: Read/write

Number of tries the connection is retried.

This property is inherited from VpnS2SInterface.

Persistent
Data type: boolean
Access type: Read/write

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

This property is inherited from VpnS2SInterface.

PostConnectionIPv4Subnet
Data type: string array
Access type: Read/write

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

This property is inherited from VpnS2SInterface.

PostConnectionIPv6Subnet
Data type: string array
Access type: Read/write

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

This property is inherited from VpnS2SInterface.

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.

This property is inherited from VpnS2SInterface.

Protocol
Data type: string
Access type: Read/write

Specifies the underlying protocol.

This property is inherited from VpnS2SInterface.

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

ResponderAuthenticationMethod
Data type: string
Access type: Read/write

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

This property is inherited from VpnS2SInterface.

MachineCertificates ("MachineCertificates")
PSKOnly ("PSKOnly")
RetryInterval
Data type: uint32
Access type: Read/write

Number of seconds between retries.

This property is inherited from VpnS2SInterface.

RxBandwidthKbps
Data type: uint64
Access type: Read/write

Sets the incoming bandwidth limit of the interface.

This property is inherited from VpnS2SInterface.

SADataSizeForRenegotiation
Data type: uint32
Access type: Read/write

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

This property is inherited from VpnS2SInterface.

SALifeTime
Data type: uint32
Access type: Read/write

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

This property is inherited from VpnS2SInterface.

SourceIpAddress
Data type: string
Access type: Read/write

Sets the IP address of the interface.

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

This property is inherited from VpnS2SInterface.

TxBandwidthKbps
Data type: uint64
Access type: Read/write

Sets the outgoing bandwidth limit of the interface.

This property is inherited from VpnS2SInterface.

UnReachabilityReasons
Data type: string
Access type: Read-only

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

This property is inherited from VpnS2SInterface.

UserName
Data type: string
Access type: Read/write

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

This property is inherited from VpnS2SInterface.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012

Namespace

Root\Microsoft\Windows\RemoteAccess

MOF

RAMgmtPSProvider.mof

DLL

RAMgmtPSProvider.dll

 

 

Community Additions

ADD
Show:
© 2015 Microsoft