{'Description':'Specifies the Name of the connection','In':True}
Protocol
string
1
✓
-
{'Description':'Specifies the underlying Protocol.','In':True}
Destination
string
2
✓
-
{'Description':'Specifies the destination end-point of the S2S connection','In':True}
AdminStatus
boolean
3
✓
-
{'Description':'Specifies the admin status of the cmdlet.','In':True}
PromoteAlternate
boolean
4
✓
-
{'Description':'An alternate IP addresses that connects successfully becomes the primary IP address, and the current primary IP address is moved to the alternate list.','In':True}
AuthenticationMethod
string
5
✓
-
{'Description':'Specifies the AuthenticationMethod to be used by the S2S connection.If pre shared key is specified as authentication method. There can only be one active site to site VPN interface per destination IP address.','In':True}
PostConnectionIPv4Subnet
string
6
✓
-
{'Description':'Specifies the IPv4 subnet that is routed on this connection with metric. The routes specified do not trigger the s2s connection','In':True}
PostConnectionIPv6Subnet
string
7
✓
-
{'Description':'Specifies the IPv6 subnet that is routed on this connection with metric. The routes specified do not trigger the s2s connection','In':True}
InitiateConfigPayload
boolean
8
✓
-
{'Description':'Specifies whether Config payload negotiation should be initiated or not. If set to $False does not send any CP request to the peer','In':True}
RadiusAttributeClass
string
9
✓
-
{'Description':'Specifies Radius attribute 25 (Class). Applicable when this attribute is not received from RADIUS','In':True}
EnableQoS
uint32
10
✓
-
{'Description':'Specifies whether QoS is enabled on the interface','In':True}
TxBandwidthKbps
uint64
11
✓
-
{'Description':'Specifies Transmit bandwidth limit for the Interface in kbps.','In':True}
RxBandwidthKbps
uint64
12
✓
-
{'Description':'Specifies Receive bandwidth limit for the Interface in kbps.','In':True}
IPv4TriggerFilter
string
13
✓
-
{'Description':'Specifies IPv4 filters that trigger demand dial connection. Format is same as Filter list . NULL value will clear the triggering filter','In':True}
IPv6TriggerFilter
string
14
✓
-
{'Description':'Specifies IPv6 filter that trigger demand dial connection. Format is same as Filterlist. NULL value will clear the triggering Filter','In':True}
Persistent
boolean
15
✓
-
{'Description':'If specified, connection is not disconnected due to idle timeout','In':True}
IPv4TriggerFilterAction
uint32
16
✓
-
{'Description':'Specifies if the Filters should trigger or should not trigger S2S connection. {Allow |Deny}','In':True}
IPv6TriggerFilterAction
uint32
17
✓
-
{'Description':'Specifies if the Filters should trigger or should not trigger S2S connection [-IPv6TriggerSubnetAction {Allow | Block}] ','In':True}
SADataSizeForRenegotiationKilobytes
uint32
18
✓
-
{'Description':'Number of Kilobytes that are allowed to transfer using a SA. After that the SA will be renegotiated ','In':True}
IPv4Subnet
string
19
✓
-
{'Description':'Specifies the IPv4 subnet that is routed on this connection with metric. The routes specified trigger the s2s connection','In':True}
IPv6Subnet
string
20
✓
-
{'Description':'Specifies the IPv6 subnet that is routed on this connection with metric. Routes specified trigger S2S connection.','In':True}
ResponderAuthenticationMethod
string
21
✓
-
{'Description':'Specifies the Responder AuthenticationMethod to be used by the S2S connection.','In':True}
PassThru
boolean
22
✓
-
{'Description':'If specified, returns the object or objects on which the operation was done.','In':True}
RoutingDomain
string
23
✓
-
{'Description':'Specifies the RoutingDomainName in which interface is to be added.','In':True}
Certificate
uint8
24
✓
-
{'Description':'Certificate to be used in default store. Applicable only if AuthenticationMethod is set to 'MachineCert'','In':True}
SharedSecret
string
25
✓
-
{'Description':'Text of the Shared Secret to be used in dialing the connection. Applicable only if AuthenticationMethod is set to 'PSK'','In':True}
NetworkOutageTimeSeconds
uint32
26
✓
-
{'Description':'Maximum network outage time after which the connection is disconnected','In':True}
NumberOfTries
uint32
27
✓
-
{'Description':'Number of tries the connection is retried. 0 means infinite.','In':True}
RetryIntervalSeconds
uint32
28
✓
-
{'Description':'Number of seconds between Retries.','In':True}
SALifeTimeSeconds
uint32
29
✓
-
{'Description':'Lifetime of a security association (SA) in seconds, after which the SA is no longer valid ','In':True}
EapMethod
string
30
✓
-
{'Description':'Specifies EAP method if IkeLocalAuthenticationMethod is EAP.','In':True}
InternalIPv4
boolean
31
✓
-
{'Description':'Specifies Negotiation of IPv4 Address.','In':True}
InternalIPv6
boolean
32
✓
-
{'Description':'Specifies Negotiation of IPv6 Address.','In':True}
IdleDisconnectSeconds
uint32
33
✓
-
{'Description':'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.','In':True}
UserName
string
34
✓
-
{'Description':'Username to be used for dialing this connection. Applicable only if AuthenticationMethod is set to 'EAP'','In':True}
Password
string
35
✓
-
{'Description':'Password of the username to be used for dialing the connection. Applicable only if AuthenticationMethod is set to 'EAP'','In':True}
CustomPolicy
boolean
36
✓
-
{'Description':'Specifies custom IKE IPSEC policies.','In':True}
EncryptionMethod
uint32
37
✓
-
{'Description':'Encryption method plumbed in IKE policy','In':True}
IntegrityCheckMethod
uint32
38
✓
-
{'Description':'Integrity method plumbed in IPsec policy','In':True}
CipherTransformConstants
uint32
39
✓
-
{'Description':'Cipher plumbed in Ipsec policy.','In':True}
AuthenticationTransformConstants
uint32
40
✓
-
{'Description':'Auth transform plumbed in Ipsec policy','In':True}
PfsGroup
uint32
41
✓
-
{'Description':'PFS Group plumbed in Ipsec policy.','In':True}
DHGroup
uint32
42
✓
-
{'Description':'DH group plumbed in IPsec policy','In':True}
{'Description':'Object containing the following fields is returned:NameDestinationAdminStatusConnectionStateIPv4SubnetIPv6SubnetProtocolEncryptionTypeAuthenticationMethodEapMethodCertificateUserNameResponderAuthenticationMethodNumberOfTriesRetryInterval(s)SADataSizeForRenegotiation(KB)SALifeTime(s)NetworkOutageTime(s)IdleDisconnect(s)InternalIPv4InternalIPv6PromoteAlternateLastErrorUnReachabilityReasonsCustomPolicyAuthenticationTransformConstantDHGroupCipherTransformConstantEncryptionMethodIntegrityCheckMethodPfsGroupRoutingDomainInitiateConfigPayloadRadiusAttributeClassEnableQoSTxBandwidthKbpsRxBandwidthKbpsIPV4TriggerSubnetIPV6TriggerSubnetPersistent','EmbeddedInstance':'VpnS2SInterface','Out':True}
Description
'This cmdlet is used to create a S2S Interface with the specified parameters'
implemented
True
static
True
AddByCustomPolicy method is in 1 class (PS_VpnS2SInterface) of ROOT\Microsoft\Windows\RemoteAccess and in 2 namespaces
{'Description':'Specifies the Name of the connection','In':True}
Protocol
string
1
✓
-
{'Description':'Specifies the underlying Protocol.','In':True}
Destination
string
2
✓
-
{'Description':'Specifies the destination end-point of the S2S connection','In':True}
AdminStatus
boolean
3
✓
-
{'Description':'Specifies the admin status of the cmdlet.','In':True}
PromoteAlternate
boolean
4
✓
-
{'Description':'An alternate IP addresses that connects successfully becomes the primary IP address, and the current primary IP address is moved to the alternate list.','In':True}
AuthenticationMethod
string
5
✓
-
{'Description':'Specifies the AuthenticationMethod to be used by the S2S connection.If pre shared key is specified as authentication method. There can only be one active site to site VPN interface per destination IP address.','In':True}
PostConnectionIPv4Subnet
string
6
✓
-
{'Description':'Specifies the IPv4 subnet that is routed on this connection with metric. The routes specified do not trigger the s2s connection','In':True}
PostConnectionIPv6Subnet
string
7
✓
-
{'Description':'Specifies the IPv6 subnet that is routed on this connection with metric. The routes specified do not trigger the s2s connection','In':True}
InitiateConfigPayload
boolean
8
✓
-
{'Description':'Specifies whether Config payload negotiation should be initiated or not. If set to $False does not send any CP request to the peer','In':True}
RadiusAttributeClass
string
9
✓
-
{'Description':'Specifies Radius attribute 25 (Class). Applicable when this attribute is not received from RADIUS','In':True}
EnableQoS
uint32
10
✓
-
{'Description':'Specifies whether QoS is enabled on the interface','In':True}
TxBandwidthKbps
uint64
11
✓
-
{'Description':'Specifies Transmit bandwidth limit for the Interface in kbps.','In':True}
RxBandwidthKbps
uint64
12
✓
-
{'Description':'Specifies Receive bandwidth limit for the Interface in kbps.','In':True}
IPv4TriggerFilter
string
13
✓
-
{'Description':'Specifies IPv4 filters that trigger demand dial connection. Format is same as Filter list . NULL value will clear the triggering filter','In':True}
IPv6TriggerFilter
string
14
✓
-
{'Description':'Specifies IPv6 filter that trigger demand dial connection. Format is same as Filterlist. NULL value will clear the triggering Filter','In':True}
Persistent
boolean
15
✓
-
{'Description':'If specified, connection is not disconnected due to idle timeout','In':True}
IPv4TriggerFilterAction
uint32
16
✓
-
{'Description':'Specifies if the Filters should trigger or should not trigger S2S connection. {Allow |Deny}','In':True}
IPv6TriggerFilterAction
uint32
17
✓
-
{'Description':'Specifies if the Filters should trigger or should not trigger S2S connection [-IPv6TriggerSubnetAction {Allow | Block}] ','In':True}
SADataSizeForRenegotiationKilobytes
uint32
18
✓
-
{'Description':'Number of Kilobytes that are allowed to transfer using a SA. After that the SA will be renegotiated ','In':True}
IPv4Subnet
string
19
✓
-
{'Description':'Specifies the IPv4 subnet that is routed on this connection with metric. The routes specified trigger the s2s connection','In':True}
IPv6Subnet
string
20
✓
-
{'Description':'Specifies the IPv6 subnet that is routed on this connection with metric. Routes specified trigger S2S connection.','In':True}
ResponderAuthenticationMethod
string
21
✓
-
{'Description':'Specifies the Responder AuthenticationMethod to be used by the S2S connection.','In':True}
PassThru
boolean
22
✓
-
{'Description':'If specified, returns the object or objects on which the operation was done.','In':True}
RoutingDomain
string
23
✓
-
{'Description':'Specifies the RoutingDomainName in which interface is to be added.','In':True}
Certificate
uint8
24
✓
-
{'Description':'Certificate to be used in default store. Applicable only if AuthenticationMethod is set to 'MachineCert'','In':True}
SharedSecret
string
25
✓
-
{'Description':'Text of the Shared Secret to be used in dialing the connection. Applicable only if AuthenticationMethod is set to 'PSK'','In':True}
NetworkOutageTimeSeconds
uint32
26
✓
-
{'Description':'Maximum network outage time after which the connection is disconnected','In':True}
NumberOfTries
uint32
27
✓
-
{'Description':'Number of tries the connection is retried. 0 means infinite.','In':True}
RetryIntervalSeconds
uint32
28
✓
-
{'Description':'Number of seconds between Retries.','In':True}
SALifeTimeSeconds
uint32
29
✓
-
{'Description':'Lifetime of a security association (SA) in seconds, after which the SA is no longer valid ','In':True}
EapMethod
string
30
✓
-
{'Description':'Specifies EAP method if IkeLocalAuthenticationMethod is EAP.','In':True}
InternalIPv4
boolean
31
✓
-
{'Description':'Specifies Negotiation of IPv4 Address.','In':True}
InternalIPv6
boolean
32
✓
-
{'Description':'Specifies Negotiation of IPv6 Address.','In':True}
IdleDisconnectSeconds
uint32
33
✓
-
{'Description':'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.','In':True}
UserName
string
34
✓
-
{'Description':'Username to be used for dialing this connection. Applicable only if AuthenticationMethod is set to 'EAP'','In':True}
Password
string
35
✓
-
{'Description':'Password of the username to be used for dialing the connection. Applicable only if AuthenticationMethod is set to 'EAP'','In':True}
EncryptionType
string
36
✓
-
{'Description':'Specifies the type of Encryption','In':True}
{'Description':'Object containing the following fields is returned:NameDestinationAdminStatusConnectionStateIPv4SubnetIPv6SubnetProtocolEncryptionTypeAuthenticationMethodEapMethodCertificateUserNameResponderAuthenticationMethodNumberOfTriesRetryInterval(s)SADataSizeForRenegotiation(KB)SALifeTime(s)NetworkOutageTime(s)IdleDisconnect(s)InternalIPv4InternalIPv6PromoteAlternateLastErrorUnReachabilityReasonsCustomPolicyAuthenticationTransformConstantDHGroupCipherTransformConstantEncryptionMethodIntegrityCheckMethodPfsGroupRoutingDomainInitiateConfigPayloadRadiusAttributeClassEnableQoSTxBandwidthKbpsRxBandwidthKbpsIPV4TriggerSubnetIPV6TriggerSubnetPersistent','EmbeddedInstance':'VpnS2SInterface','Out':True}
Description
'This cmdlet is used to create a S2S Interface with the specified parameters'
implemented
True
static
True
AddByEncryptionType method is in 1 class (PS_VpnS2SInterface) of ROOT\Microsoft\Windows\RemoteAccess and in 2 namespaces
{'Description':'Object containing the following fields is returned:NameDestinationAdminStatusConnectionStateIPv4SubnetIPv6SubnetProtocolEncryptionTypeAuthenticationMethodEapMethodCertificateUserNameResponderAuthenticationMethodNumberOfTriesRetryInterval(s)SADataSizeForRenegotiation(KB)SALifeTime(s)NetworkOutageTime(s)IdleDisconnect(s)InternalIPv4InternalIPv6PromoteAlternateLastErrorUnReachabilityReasonsCustomPolicyAuthenticationTransformConstantDHGroupCipherTransformConstantEncryptionMethodIntegrityCheckMethodPfsGroupRoutingDomainInitiateConfigPayloadRadiusAttributeClassEnableQoSTxBandwidthKbpsRxBandwidthKbpsIPV4TriggerSubnetIPV6TriggerSubnetPersistent','EmbeddedInstance':'VpnS2SInterface','Out':True}
Description
'This cmdlet is used to connect a S2S Interface that is currently not connected'
implemented
True
static
True
Connect method is in 1 class (PS_VpnS2SInterface) of ROOT\Microsoft\Windows\RemoteAccess and in 3 namespaces
{'Description':'Object containing the following fields is returned:NameDestinationAdminStatusConnectionStateIPv4SubnetIPv6SubnetProtocolEncryptionTypeAuthenticationMethodEapMethodCertificateUserNameResponderAuthenticationMethodNumberOfTriesRetryInterval(s)SADataSizeForRenegotiation(KB)SALifeTime(s)NetworkOutageTime(s)IdleDisconnect(s)InternalIPv4InternalIPv6PromoteAlternateLastErrorUnReachabilityReasonsCustomPolicyAuthenticationTransformConstantDHGroupCipherTransformConstantEncryptionMethodIntegrityCheckMethodPfsGroupRoutingDomainInitiateConfigPayloadRadiusAttributeClassEnableQoSTxBandwidthKbpsRxBandwidthKbpsIPV4TriggerSubnetIPV6TriggerSubnetPersistent','EmbeddedInstance':'VpnS2SInterface','Out':True}
Description
'This cmdlet is used to disconnect a S2S Interface that is currently connected.'
implemented
True
static
True
Disconnect method is in 1 class (PS_VpnS2SInterface) of ROOT\Microsoft\Windows\RemoteAccess and in 7 namespaces
{'Description':'Object containing the following fields is returned:NameDestinationAdminStatusConnectionStateIPv4SubnetIPv6SubnetProtocolEncryptionTypeAuthenticationMethodEapMethodCertificateUserNameResponderAuthenticationMethodNumberOfTriesRetryInterval(s)SADataSizeForRenegotiation(KB)SALifeTime(s)NetworkOutageTime(s)IdleDisconnect(s)InternalIPv4InternalIPv6PromoteAlternateLastErrorUnReachabilityReasonsCustomPolicyAuthenticationTransformConstantDHGroupCipherTransformConstantEncryptionMethodIntegrityCheckMethodPfsGroupRoutingDomainInitiateConfigPayloadRadiusAttributeClassEnableQoSTxBandwidthKbpsRxBandwidthKbpsIPV4TriggerSubnetIPV6TriggerSubnetPersistent','EmbeddedInstance':'VpnS2SInterface','Out':True}
Description
'This cmdlet is used to retrieve details of a S2S Interface'
{'Description':'Object containing the following fields is returned:NameDestinationAdminStatusConnectionStateIPv4SubnetIPv6SubnetProtocolEncryptionTypeAuthenticationMethodEapMethodCertificateUserNameResponderAuthenticationMethodNumberOfTriesRetryInterval(s)SADataSizeForRenegotiation(KB)SALifeTime(s)NetworkOutageTime(s)IdleDisconnect(s)InternalIPv4InternalIPv6PromoteAlternateLastErrorUnReachabilityReasonsCustomPolicyAuthenticationTransformConstantDHGroupCipherTransformConstantEncryptionMethodIntegrityCheckMethodPfsGroupRoutingDomainInitiateConfigPayloadRadiusAttributeClassEnableQoSTxBandwidthKbpsRxBandwidthKbpsIPV4TriggerSubnetIPV6TriggerSubnetPersistent','EmbeddedInstance':'VpnS2SInterface','Out':True}
Description
'This cmdlet is used to remove a specified S2S Interface'
{'Description':'Specifies the destination end-point of the S2S connection.','In':True}
AdminStatus
boolean
1
✓
-
{'Description':'Specifies the admin status of the cmdlet.','In':True}
PromoteAlternate
boolean
2
✓
-
{'Description':'An alternate IP addresses that connects successfully becomes the primary IP address, and the current primary IP address is moved to the alternate list.','In':True}
AuthenticationMethod
string
3
✓
-
{'Description':'Specifies the AuthenticationMethod to be used by the S2S connection.','In':True}
EapMethod
string
4
✓
-
{'Description':'Specifies EAP method if IkeLocalAuthenticationMethod is EAP.','In':True}
InternalIPv4
boolean
5
✓
-
{'Description':'Specifies Negotiation of IPv4 Address.','In':True}
Force
boolean
6
✓
-
{'Description':'If specified, overrides the default confirmation before performing the operation.','In':True}
PostConnectionIPv4Subnet
string
7
✓
-
{'Description':'Specifies the IPv4 subnet that is routed on this connection with metric. The routes specified do not trigger the s2s connection','In':True}
IPv4TriggerFilter
string
8
✓
-
{'Description':'Specifies IPv4 filters that trigger demand dial connection. Format is same as Filter list . NULL value will clear the triggering filter','In':True}
IPv4TriggerFilterAction
uint32
9
✓
-
{'Description':'Specifies if the Filters should trigger or should not trigger S2S connection. {Allow |Deny}','In':True}
PostConnectionIPv6Subnet
string
10
✓
-
{'Description':'Specifies the IPv6 subnet that is routed on this connection with metric. The routes specified do not trigger the s2s connection','In':True}
IPv6TriggerFilter
string
11
✓
-
{'Description':'Specifies IPv6 filter that trigger demand dial connection. Format is same as Filterlist. NULL value will clear the triggering Filter','In':True}
IPv6TriggerFilterAction
uint32
12
✓
-
{'Description':'Specifies if the Filters should trigger or should not trigger S2S connection [-IPv6TriggerSubnetAction {Allow | Block}] ','In':True}
IPv4Subnet
string
13
✓
-
{'Description':'Specifies the IPv4 subnet that is routed on this connection with metric.','In':True}
Name
string
14
✓
-
{'Description':'Specifies the Name of the connection.','In':True}
ResponderAuthenticationMethod
string
15
✓
-
{'Description':'Specifies the Responder AuthenticationMethod to be used by the S2S connection.','In':True}
PassThru
boolean
16
✓
-
{'Description':'If specified, returns the object or objects on which the operation was done.','In':True}
Persistent
boolean
17
✓
-
{'Description':'If specified, connection is not disconnected due to idle timeout','In':True}
InitiateConfigPayload
boolean
18
✓
-
{'Description':'Specifies whether Config payload negotiation should be initiated or not. If set to $False does not send any CP request to the peer','In':True}
RadiusAttributeClass
string
19
✓
-
{'Description':'Specifies Radius attribute 25 (Class). Applicable when this attribute is not received from RADIUS','In':True}
EnableQoS
uint32
20
✓
-
{'Description':'Specifies whether QoS is enabled on the interface','In':True}
TxBandwidthKbps
uint64
21
✓
-
{'Description':'Specifies Transmit bandwidth limit for the Interface in kbps.','In':True}
RxBandwidthKbps
uint64
22
✓
-
{'Description':'Specifies Receive bandwidth limit for the Interface in kbps.','In':True}
NetworkOutageTimeSeconds
uint32
23
✓
-
{'Description':'Maximum network outage time after which the connection is disconnected.','In':True}
NumberOfTries
uint32
24
✓
-
{'Description':'Number of tries the connection is retried.0 means infinite.','In':True}
RetryIntervalSeconds
uint32
25
✓
-
{'Description':'Number of seconds between Retries.','In':True}
SADataSizeForRenegotiationKilobytes
uint32
26
✓
-
{'Description':'Number of Kilobytes that are allowed to transfer using a SA. After that the SA will be renegotiated .','In':True}
SALifeTimeSeconds
uint32
27
✓
-
{'Description':'Lifetime of a security association (SA) in seconds, after which the SA is no longer valid .','In':True}
IPv6Subnet
string
28
✓
-
{'Description':'Specifies the IPv6 subnet that is routed on this connection with metric.','In':True}
InternalIPv6
boolean
29
✓
-
{'Description':'Specifies Negotiation of IPv6 Address.','In':True}
IdleDisconnectSeconds
uint32
30
✓
-
{'Description':'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.','In':True}
UserName
string
31
✓
-
{'Description':'Username to be used for dialing this connection. Applicable only if AuthenticationMethod is set to 'EAP'.','In':True}
Password
string
32
✓
-
{'Description':'Password of the username to be used for dialing the connection.Applicable only if AuthenticationMethod is set to 'EAP'.','In':True}
Certificate
uint8
33
✓
-
{'Description':'Subject Name of the certificate to be used in default store. Applicable only if AuthenticationMethod is set to 'MachineCert'.','In':True}
SharedSecret
string
34
✓
-
{'Description':'Text of the Shared Secret to be used in dialing the connection. Applicable only if AuthenticationMethod is set to 'PSK'.','In':True}
EncryptionMethod
uint32
35
✓
-
{'Description':'Encryption Method Plumbed in IKE policy.','In':True}
IntegrityCheckMethod
uint32
36
✓
-
{'Description':'Integrity method plumbed in IPsec policy.','In':True}
CipherTransformConstants
uint32
37
✓
-
{'Description':'Cipher plumbed in Ipsec policy.','In':True}
DHGroup
uint32
38
✓
-
{'Description':'DH Group Plumbed in Ipsec policy.','In':True}
AuthenticationTransformConstants
uint32
39
✓
-
{'Description':'Auth transform plumbed in Ipsec policy.','In':True}
PfsGroup
uint32
40
✓
-
{'Description':'PFS Group plumbed in Ipsec policy.','In':True}
CustomPolicy
boolean
41
✓
-
{'Description':'Specifies custom IKE IPSEC policies, must be a separate parameter set','In':True}
{'Description':'Object containing the following fields is returned:NameDestinationAdminStatusConnectionStateIPv4SubnetIPv6SubnetProtocolEncryptionTypeAuthenticationMethodEapMethodCertificateUserNameResponderAuthenticationMethodNumberOfTriesRetryInterval(s)SADataSizeForRenegotiation(KB)SALifeTime(s)NetworkOutageTime(s)IdleDisconnect(s)InternalIPv4InternalIPv6PromoteAlternateLastErrorUnReachabilityReasonsCustomPolicyAuthenticationTransformConstantDHGroupCipherTransformConstantEncryptionMethodIntegrityCheckMethodPfsGroupRoutingDomainInitiateConfigPayloadRadiusAttributeClassEnableQoSTxBandwidthKbpsRxBandwidthKbpsIPV4TriggerSubnetIPV6TriggerSubnetPersistent','EmbeddedInstance':'VpnS2SInterface','Out':True}
Description
'This cmdlet is used to modify parameters a S2S Interface. If the interface is already connected, the changes take effect after disconnection.'
{'Description':'Specifies the destination end-point of the S2S connection.','In':True}
AdminStatus
boolean
1
✓
-
{'Description':'Specifies the admin status of the cmdlet.','In':True}
PromoteAlternate
boolean
2
✓
-
{'Description':'An alternate IP addresses that connects successfully becomes the primary IP address, and the current primary IP address is moved to the alternate list.','In':True}
AuthenticationMethod
string
3
✓
-
{'Description':'Specifies the AuthenticationMethod to be used by the S2S connection.','In':True}
EapMethod
string
4
✓
-
{'Description':'Specifies EAP method if IkeLocalAuthenticationMethod is EAP.','In':True}
InternalIPv4
boolean
5
✓
-
{'Description':'Specifies Negotiation of IPv4 Address.','In':True}
Force
boolean
6
✓
-
{'Description':'If specified, overrides the default confirmation before performing the operation.','In':True}
PostConnectionIPv4Subnet
string
7
✓
-
{'Description':'Specifies the IPv4 subnet that is routed on this connection with metric. The routes specified do not trigger the s2s connection','In':True}
IPv4TriggerFilter
string
8
✓
-
{'Description':'Specifies IPv4 filters that trigger demand dial connection. Format is same as Filter list . NULL value will clear the triggering filter','In':True}
IPv4TriggerFilterAction
uint32
9
✓
-
{'Description':'Specifies if the Filters should trigger or should not trigger S2S connection. {Allow |Deny}','In':True}
PostConnectionIPv6Subnet
string
10
✓
-
{'Description':'Specifies the IPv6 subnet that is routed on this connection with metric. The routes specified do not trigger the s2s connection','In':True}
IPv6TriggerFilter
string
11
✓
-
{'Description':'Specifies IPv6 filter that trigger demand dial connection. Format is same as Filterlist. NULL value will clear the triggering Filter','In':True}
IPv6TriggerFilterAction
uint32
12
✓
-
{'Description':'Specifies if the Filters should trigger or should not trigger S2S connection [-IPv6TriggerSubnetAction {Allow | Block}] ','In':True}
IPv4Subnet
string
13
✓
-
{'Description':'Specifies the IPv4 subnet that is routed on this connection with metric.','In':True}
Name
string
14
✓
-
{'Description':'Specifies the Name of the connection.','In':True}
ResponderAuthenticationMethod
string
15
✓
-
{'Description':'Specifies the Responder AuthenticationMethod to be used by the S2S connection.','In':True}
PassThru
boolean
16
✓
-
{'Description':'If specified, returns the object or objects on which the operation was done.','In':True}
Persistent
boolean
17
✓
-
{'Description':'If specified, connection is not disconnected due to idle timeout','In':True}
InitiateConfigPayload
boolean
18
✓
-
{'Description':'Specifies whether Config payload negotiation should be initiated or not. If set to $False does not send any CP request to the peer','In':True}
RadiusAttributeClass
string
19
✓
-
{'Description':'Specifies Radius attribute 25 (Class). Applicable when this attribute is not received from RADIUS','In':True}
EnableQoS
uint32
20
✓
-
{'Description':'Specifies whether QoS is enabled on the interface','In':True}
TxBandwidthKbps
uint64
21
✓
-
{'Description':'Specifies Transmit bandwidth limit for the Interface in kbps.','In':True}
RxBandwidthKbps
uint64
22
✓
-
{'Description':'Specifies Receive bandwidth limit for the Interface in kbps.','In':True}
NetworkOutageTimeSeconds
uint32
23
✓
-
{'Description':'Maximum network outage time after which the connection is disconnected.','In':True}
NumberOfTries
uint32
24
✓
-
{'Description':'Number of tries the connection is retried.0 means infinite.','In':True}
RetryIntervalSeconds
uint32
25
✓
-
{'Description':'Number of seconds between Retries.','In':True}
SADataSizeForRenegotiationKilobytes
uint32
26
✓
-
{'Description':'Number of Kilobytes that are allowed to transfer using a SA. After that the SA will be renegotiated .','In':True}
SALifeTimeSeconds
uint32
27
✓
-
{'Description':'Lifetime of a security association (SA) in seconds, after which the SA is no longer valid .','In':True}
IPv6Subnet
string
28
✓
-
{'Description':'Specifies the IPv6 subnet that is routed on this connection with metric.','In':True}
InternalIPv6
boolean
29
✓
-
{'Description':'Specifies Negotiation of IPv6 Address.','In':True}
IdleDisconnectSeconds
uint32
30
✓
-
{'Description':'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.','In':True}
UserName
string
31
✓
-
{'Description':'Username to be used for dialing this connection. Applicable only if AuthenticationMethod is set to 'EAP'.','In':True}
Password
string
32
✓
-
{'Description':'Password of the username to be used for dialing the connection.Applicable only if AuthenticationMethod is set to 'EAP'.','In':True}
Certificate
uint8
33
✓
-
{'Description':'Subject Name of the certificate to be used in default store. Applicable only if AuthenticationMethod is set to 'MachineCert'.','In':True}
SharedSecret
string
34
✓
-
{'Description':'Text of the Shared Secret to be used in dialing the connection. Applicable only if AuthenticationMethod is set to 'PSK'.','In':True}
EncryptionType
string
35
✓
-
{'Description':'Specifies the type of Encryption.','In':True}
{'Description':'Object containing the following fields is returned:NameDestinationAdminStatusConnectionStateIPv4SubnetIPv6SubnetProtocolEncryptionTypeAuthenticationMethodEapMethodCertificateUserNameResponderAuthenticationMethodNumberOfTriesRetryInterval(s)SADataSizeForRenegotiation(KB)SALifeTime(s)NetworkOutageTime(s)IdleDisconnect(s)InternalIPv4InternalIPv6PromoteAlternateLastErrorUnReachabilityReasonsCustomPolicyAuthenticationTransformConstantDHGroupCipherTransformConstantEncryptionMethodIntegrityCheckMethodPfsGroupRoutingDomainInitiateConfigPayloadRadiusAttributeClassEnableQoSTxBandwidthKbpsRxBandwidthKbpsIPV4TriggerSubnetIPV6TriggerSubnetPersistent','EmbeddedInstance':'VpnS2SInterface','Out':True}
Description
'This cmdlet is used to modify parameters a S2S Interface. If the interface is already connected, the changes take effect after disconnection.'