Set-Remote Access Routing Domain

Module:: remoteaccess

Configures S2S VPN settings for a routing domain configuration.

Syntax

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

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

Description

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

Examples

Example 1: Modify the configuration for a routing domain

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


RoutingDomain                  : Rd_01
RoutingDomainID                : {11111111-1111-1111-1111-111111111001}
RoutingStatus                  : Enabled and Available
Capacity(Kbps)                 : 10240
IPAddressRange                 : {10.0.0.1 - 10.0.0.10}
IPv6Prefix                     : :: IdleDisconnect(s)              : 0
SADataSizeForRenegotiation(KB) : 0
SALifeTime(s)                  : 0
InterimAccounting(s)           : EncryptionType                 : NoEncryption

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

Example 2: Modify configuration for IPv6 addresses and encryption

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


RoutingDomain                  : Rd_01
RoutingDomainID                : {11111111-1111-1111-1111-111111111001}
RoutingStatus                  : Enabled and Available
Capacity(Kbps)                 : 10240
IPAddressRange                 : {10.0.0.1 - 10.0.0.10}
IPv6Prefix                     : 3ffe:: IdleDisconnect(s)              : 0
SADataSizeForRenegotiation(KB) : 0
SALifeTime(s)                  : 0
InterimAccounting(s)           : EncryptionType                 : OptionalEncryption

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

Required Parameters

-CustomPolicy

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Specifies the name of a routing domain.

Type:	String
Aliases:	RoutingDomainName, RoutingDomain
Position:	0
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-AuthenticationTransformConstant

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

MD596
SHA196
SHA256128
GCMAES128
GCMAES192
GCMAES256
None

Type:	AuthenticationTransformConstant
Parameter Sets:	MD596, SHA196, SHA256128, GCMAES128, GCMAES192, GCMAES256, None
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

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

Type:	CimSession[]
Aliases:	Session
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-CipherTransformConstant

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

DES
DES3
AES128
AES192
AES256
GCMAES128
GCMAES192
GCMAES256
None

Type:	CipherTransformConstant
Parameter Sets:	DES, DES3, AES128, AES192, AES256, GCMAES128, GCMAES192, GCMAES256, None
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-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

Type:	DHGroup
Parameter Sets:	None, Group1, Group2, Group14, ECP256, ECP384, Group24
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-DnsIPAddress

Specifies an array of IP addresses.

Type:	IPAddress[]
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-EnableQoS

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

Enabled
Disabled

Type:	EnableQoS
Parameter Sets:	Disabled, Enabled
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName, ByValue)
Accept wildcard characters:	False

-EncryptionMethod

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

DES
DES3
AES128
AES192
AES256

Type:	EncryptionMethod
Parameter Sets:	DES, DES3, AES128, AES192, AES256
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-EncryptionType

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

NoEncryption
RequireEncryption
OptionalEncryption
MaximumEncryption

Type:	String
Parameter Sets:	NoEncryption, RequireEncryption, OptionalEncryption, MaximumEncryption
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-Force

Forces the command to run without asking for user confirmation.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-IPAddressRange

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

Type:	String[]
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-IPv6Prefix

Specifies the IPv6 prefix used for IPv6 address assignment.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-IdleDisconnectSec

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.

Type:	UInt32
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-IntegrityCheckMethod

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

MD5
SHA1
SHA256
SHA384

Type:	IntegrityCheckMethod
Parameter Sets:	MD5, SHA1, SHA256, SHA384
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-InterimAccountingPeriodSec

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

Type:	UInt32
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-MMSaLifeTimeSec

Type:	UInt32
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-MaximumVpnConnections

Specifies the maximum number of concurrent VPN connections.

Type:	UInt32
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-NetBiosIPAddress

Specifies an array of IP addresses for NetBIOS names.

Type:	IPAddress[]
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.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-PfsGroup

Specifies the PFS group in the IPsec policy.

PFS1
PFS2
PFS2048
ECP256
ECP384
PFSMM
PFS24

Type:	PfsGroup
Parameter Sets:	None, PFS1, PFS2, PFS2048, ECP256, ECP384, PFSMM, PFS24
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-RxBandwidthKbps

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

Type:	UInt64
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName, ByValue)
Accept wildcard characters:	False

-SaLifeTimeSec

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

Type:	UInt32
Aliases:	QMSaLifeTimeSec
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-SaRenegotiationDataSizeKB

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.

Type:	UInt32
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-TenantName

Specifies an array of tenant names.

Type:	String[]
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-ThrottleLimit

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.

Type:	Int32
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-TxBandwidthKbps

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

Type:	UInt64
Position:	Named
Default value:	None
Accept pipeline input:	True (ByPropertyName, ByValue)
Accept wildcard characters:	False

Outputs

Microsoft.Management.Infrastructure.CimInstance#VpnRoutingDomainConfig

Set-Remote Access Routing Domain

Syntax

Description

Examples

Required Parameters

Optional Parameters

Outputs

Feedback

Liquid error: Can't find the localized string giveDocumentationFeedback for template Conceptual.

Set-Remote Access Routing Domain

Syntax

Description

Examples

Required Parameters

Optional Parameters

Outputs

Related Links

Feedback

Liquid error: Can't find the localized string giveDocumentationFeedback for template Conceptual.