SetByCustomPolicy method of the PS_RemoteAccessRoutingDomain class

Updates site-to-site (S2S) VPN settings for a custom routing domain configuration.

Syntax

uint32 SetByCustomPolicy(
  [in]  string                 Name,
  [in]  uint32                 IdleDisconnectSec,
  [in]  uint32                 InterimAccountingPeriodSec,
  [in]  string                 IPAddressRange[],
  [in]  string                 IPv6Prefix,
  [in]  uint32                 SaLifeTimeSec,
  [in]  uint32                 MMSaLifeTimeSec,
  [in]  string                 NetBiosIPAddress[],
  [in]  uint32                 MaximumVpnConnections,
  [in]  string                 TenantName[],
  [in]  boolean                PassThru,
  [in]  boolean                Force,
  [in]  uint32                 EnableQoS,
  [in]  uint64                 TxBandwidthKbps,
  [in]  uint64                 RxBandwidthKbps,
  [in]  string                 DnsIPAddress[],
  [in]  boolean                CustomPolicy,
  [in]  uint32                 AuthenticationTransformConstant,
  [in]  uint32                 CipherTransformConstant,
  [in]  uint32                 EncryptionMethod,
  [in]  uint32                 IntegrityCheckMethod,
  [in]  uint32                 PfsGroup,
  [in]  uint32                 SaRenegotiationDataSizeKB,
  [in]  uint32                 DHGroup,
  [out] VpnRoutingDomainConfig cmdletOutput
);

Parameters

Name [in]

The name of the routing domain.

IdleDisconnectSec [in]

The time, in seconds, after which an idle connection is terminated.

InterimAccountingPeriodSec [in]

The interval, in seconds, at which to log interim accounting.

IPAddressRange [in]

An array that contains the start and end IP addresses that specify the range of IP addresses to allocate to VPN clients.

IPv6Prefix [in]

The IPv6 prefix to assign to VPN clients. If this parameter is set to Null, it will disable IPv6 VPN connections to the tenant.

SaLifeTimeSec [in]

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

MMSaLifeTimeSec [in]

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

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

NetBiosIPAddress [in]

An array that contains the Network Basic Input/Output System (NetBIOS) server IP addresses for VPN clients.

MaximumVpnConnections [in]

The maximum number of VPN connections for the routing domain.

TenantName [in]

An array that contains the tenant names that host the routing domain.

PassThru [in]

Indicates whether the cmdletOutput parameter returns and object.

Force [in]

Indicates whether this method uses the default confirmation prompt before performing the operation. True to use the default confirmation prompt, otherwise false. The default value for this parameter is True.

EnableQoS [in]

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

TxBandwidthKbps [in]

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

RxBandwidthKbps [in]

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

DnsIPAddress [in]

An array that contains the IP addresses of the Domain Name System (DNS) servers.

CustomPolicy [in]

Indicates whether to use a custom Internet Key Exchange (IKE) Internet Protocol Security (IPsec) policy. True to use a custom IKE policy; otherwise false.

AuthenticationTransformConstant [in]

The authentication transform value for the IPsec policy.

CipherTransformConstant [in]

The cipher transform value for the IPsec policy.

EncryptionMethod [in]

The encryption method for the IKE policy.

IntegrityCheckMethod [in]

The integrity method for the IPsec policy.

PfsGroup [in]

The perfect forward secrecy (PFS) Group for the IPsec policy.

SaRenegotiationDataSizeKB [in]

The amount of data, in kilobytes, to transfer using an SA before the SA is renegotiated.

DHGroup [in]

The Diffie-Hellman (DH) Group for the IPsec policy.

cmdletOutput [out]

The VpnRoutingDomainConfig object that receives the VPN settings.

Requirements

See also

PS_RemoteAccessRoutingDomain