Set-RemoteAccessRoutingDomain

Set-RemoteAccessRoutingDomain

Configures S2S VPN settings for a routing domain configuration.

Syntax

Parameter Set: EncryptionType
Set-RemoteAccessRoutingDomain [-Name] <String> [-AsJob] [-CimSession <CimSession[]> ] [-DnsIPAddress <IPAddress[]> ] [-EnableQoS <EnableQoS> ] [-EncryptionType <String> ] [-Force] [-InterimAccountingPeriodSec <UInt32> ] [-IPAddressRange <String[]> ] [-IPv6Prefix <String> ] [-MaximumVpnConnections <UInt32> ] [-NetBiosIPAddress <IPAddress[]> ] [-PassThru] [-RxBandwidthKbps <UInt64> ] [-TenantName <String[]> ] [-ThrottleLimit <Int32> ] [-TxBandwidthKbps <UInt64> ] [ <CommonParameters>]

Parameter Set: CustomPolicy
Set-RemoteAccessRoutingDomain [-Name] <String> -CustomPolicy [-AsJob] [-AuthenticationTransformConstant <AuthenticationTransformConstant> ] [-CimSession <CimSession[]> ] [-CipherTransformConstant <CipherTransformConstant> ] [-DHGroup <DHGroup> ] [-DnsIPAddress <IPAddress[]> ] [-EnableQoS <EnableQoS> ] [-EncryptionMethod <EncryptionMethod> ] [-Force] [-IdleDisconnectSec <UInt32> ] [-IntegrityCheckMethod <IntegrityCheckMethod> ] [-InterimAccountingPeriodSec <UInt32> ] [-IPAddressRange <String[]> ] [-IPv6Prefix <String> ] [-MaximumVpnConnections <UInt32> ] [-NetBiosIPAddress <IPAddress[]> ] [-PassThru] [-PfsGroup <PfsGroup> ] [-RxBandwidthKbps <UInt64> ] [-SaLifeTimeSec <UInt32> ] [-SaRenegotiationDataSizeKB <UInt32> ] [-TenantName <String[]> ] [-ThrottleLimit <Int32> ] [-TxBandwidthKbps <UInt64> ] [ <CommonParameters>]

Detailed Description

The Set-RemoteAccessRoutingDomain cmdlet configures site to site (S2S) virtual private network (VPN) settings for a routing domain.

Parameters

-AsJob

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-AuthenticationTransformConstant<AuthenticationTransformConstant>

Specifies a transform constant. The acceptable values for this parameter are:

-- MD596
-- SHA196
-- SHA256128
-- GCMAES128
-- GCMAES192
-- GCMAES256
-- None

Aliases	none
Required?	false
Position?	named
Default Value	2
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases	Session
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-CipherTransformConstant<CipherTransformConstant>

Specifies a cipher transform constant. The acceptable values for this parameter are:

-- DES
-- DES3
-- AES128
-- AES192
-- AES256
-- GCMAES128
-- GCMAES192
-- GCMAES256
-- None

Aliases	none
Required?	false
Position?	named
Default Value	1
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-CustomPolicy

Indicates that the interface uses custom Internet Key Exchange (IKE) IPsec policies.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DHGroup<DHGroup>

Specifies the Diffie-Hellman (DH) group for the IKE policy. The acceptable values for this parameter are:

-- None
-- Group1
-- Group2
-- Group14
-- ECP256
-- ECP384
-- Group24

Aliases	none
Required?	false
Position?	named
Default Value	2
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-DnsIPAddress<IPAddress[]>

Specifies an array of IP addresses.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-EnableQoS<EnableQoS>

Indicates whether to enable Quality of Service (QoS) on an interface. The acceptable values for this parameter are:

-- Enabled
-- Disabled

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue, ByPropertyName)
Accept Wildcard Characters?	false

-EncryptionMethod<EncryptionMethod>

Specifies the encryption method for IKE policy. The acceptable values for this parameter are:

-- DES
-- DES3
-- AES128
-- AES192
-- AES256

Aliases	none
Required?	false
Position?	named
Default Value	4
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-EncryptionType<String>

Specifies the type of encryption. The acceptable values for this parameter are:

-- NoEncryption
-- RequireEncryption
-- OptionalEncryption
-- MaximumEncryption

Aliases	none
Required?	false
Position?	named
Default Value	RequireEncryption
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Force

Forces the command to run without asking for user confirmation.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-IdleDisconnectSec<UInt32>

Specifies the time interval, in seconds, after which an idle connection is disconnected. Unless you disable idle timeout, an idle connection is disconnected after this time interval is exceeded.

Aliases	none
Required?	false
Position?	named
Default Value	300
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-IntegrityCheckMethod<IntegrityCheckMethod>

Specifies an integrity check method for the IPsec policy. The acceptable values for this parameter are:

-- MD5
-- SHA1
-- SHA256
-- SHA384

Aliases	none
Required?	false
Position?	named
Default Value	2
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-InterimAccountingPeriodSec<UInt32>

Specifies a time interval, in seconds, for interim accounting.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-IPAddressRange<String[]>

Specifies an array of IP addresses to allocate to VPN clients. The array consists of a beginning IP address and an ending IP address.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-IPv6Prefix<String>

Specifies the IPv6 prefix used for IPv6 address assignment.

Aliases	none
Required?	false
Position?	named
Default Value	fe80::/64
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-MaximumVpnConnections<UInt32>

Specifies the maximum number of concurrent VPN connections.

Aliases	none
Required?	false
Position?	named
Default Value	100
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Name<String>

Specifies the name of a routing domain.

Aliases	RoutingDomainName,RoutingDomain
Required?	true
Position?	1
Default Value	null
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-NetBiosIPAddress<IPAddress[]>

Specifies an array of IP addresses for NetBIOS names.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-PfsGroup<PfsGroup>

Specifies the PFS group in the IPsec policy.

-- PFS1
-- PFS2
-- PFS2048
-- ECP256
-- ECP384
-- PFSMM
-- PFS24

Aliases	none
Required?	false
Position?	named
Default Value	3
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-RxBandwidthKbps<UInt64>

Specifies the receive, or ingress, bandwidth limit, in kilobits per second (Kbps).

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue, ByPropertyName)
Accept Wildcard Characters?	false

-SaLifeTimeSec<UInt32>

Specifies the lifetime, in seconds, of a security association (SA). The SA is no longer valid after this time interval.

Aliases	none
Required?	false
Position?	named
Default Value	7200
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-SaRenegotiationDataSizeKB<UInt32>

Specifies the amount of data, in kilobytes (KB), that can be transferred using a security association (SA). When the limit is reached, the SA must be renegotiated.

Aliases	none
Required?	false
Position?	named
Default Value	10000
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-TenantName<String[]>

Specifies an array of tenant names.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-TxBandwidthKbps<UInt64>

Specifies a transmit, or egress, bandwidth limit, in Kbps, for the interface.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue, ByPropertyName)
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• Microsoft.Management.Infrastructure.CimInstance#VpnRoutingDomainConfig

Examples

Example 1: Modify the configuration for a routing domain

This command modifies configuration settings for a specified routing domain in a multitenant environment and displays the resulting configuration.

PS C:\> Set-RemoteAccessRoutingDomain -RoutingDomain Rd_01 -IPAddressRange @("10.0.0.1","10.0.0.10") -Passthru

Example 2: Modify configuration for IPv6 addresses and encryption

This command modifies configuration settings for a routing domain in a multitenant environment and displays the resulting configuration.

PS C:\> Set-RemoteAccessRoutingDomain -RoutingDomain Rd_01 -IPAddressRange @("10.0.0.1","10.0.0.10") -IPv6Prefix 3ffe::/64   -EncryptionType OptionalEncryption    -Passthru

Related topics

Disable-RemoteAccessRoutingDomain

Enable-RemoteAccessRoutingDomain

Get-RemoteAccessRoutingDomain