Edit

Share via

Set-RemoteAccessRoutingDomain

Module:
RemoteAccess Module

Configures S2S VPN settings for a routing ___domain configuration.

Syntax

EncryptionType (Default) 

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

CustomPolicy 

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.

Parameters

-AsJob

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AuthenticationTransformConstant

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

  • MD596
  • SHA196
  • SHA256128
  • GCMAES128
  • GCMAES192
  • GCMAES256
  • None

Parameter properties

Type:AuthenticationTransformConstant
Default value:None
Accepted values:MD596, SHA196, SHA256128, GCMAES128, GCMAES192, GCMAES256, None
Supports wildcards:False
DontShow:False

Parameter sets

CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CipherTransformConstant

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

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

Parameter properties

Type:CipherTransformConstant
Default value:None
Accepted values:DES, DES3, AES128, AES192, AES256, GCMAES128, GCMAES192, GCMAES256, None
Supports wildcards:False
DontShow:False

Parameter sets

CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-CustomPolicy

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CustomPolicy
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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

Parameter properties

Type:DHGroup
Default value:None
Accepted values:None, Group1, Group2, Group14, ECP256, ECP384, Group24
Supports wildcards:False
DontShow:False

Parameter sets

CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DnsIPAddress

Specifies an array of IP addresses.

Parameter properties

Type:

IPAddress[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-EnableQoS

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

  • Enabled
  • Disabled

Parameter properties

Type:EnableQoS
Default value:None
Accepted values:Disabled, Enabled
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-EncryptionMethod

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

  • DES
  • DES3
  • AES128
  • AES192
  • AES256

Parameter properties

Type:EncryptionMethod
Default value:None
Accepted values:DES, DES3, AES128, AES192, AES256
Supports wildcards:False
DontShow:False

Parameter sets

CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-EncryptionType

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

  • NoEncryption
  • RequireEncryption
  • OptionalEncryption
  • MaximumEncryption

Parameter properties

Type:String
Default value:None
Accepted values:NoEncryption, RequireEncryption, OptionalEncryption, MaximumEncryption
Supports wildcards:False
DontShow:False

Parameter sets

EncryptionType
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-IntegrityCheckMethod

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

  • MD5
  • SHA1
  • SHA256
  • SHA384

Parameter properties

Type:IntegrityCheckMethod
Default value:None
Accepted values:MD5, SHA1, SHA256, SHA384
Supports wildcards:False
DontShow:False

Parameter sets

CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-InterimAccountingPeriodSec

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

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-IPv6Prefix

Specifies the IPv6 prefix used for IPv6 address assignment.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-MaximumVpnConnections

Specifies the maximum number of concurrent VPN connections.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-MMSaLifeTimeSec

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

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Name

Specifies the name of a routing ___domain.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RoutingDomainName, RoutingDomain

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-NetBiosIPAddress

Specifies an array of IP addresses for NetBIOS names.

Parameter properties

Type:

IPAddress[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PassThru

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PfsGroup

Specifies the PFS group in the IPsec policy.

  • PFS1
  • PFS2
  • PFS2048
  • ECP256
  • ECP384
  • PFSMM
  • PFS24

Parameter properties

Type:PfsGroup
Default value:None
Accepted values:None, PFS1, PFS2, PFS2048, ECP256, ECP384, PFSMM, PFS24
Supports wildcards:False
DontShow:False

Parameter sets

CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-RxBandwidthKbps

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

Parameter properties

Type:UInt64
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-SaLifeTimeSec

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

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:QMSaLifeTimeSec

Parameter sets

CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CustomPolicy
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-TenantName

Specifies an array of tenant names.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TxBandwidthKbps

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

Parameter properties

Type:UInt64
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Nullable<T>

UInt32

String

IPAddress

Nullable<T>

Nullable<T>

Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoteAccessRoutingDomain.AuthenticationTransformConstant

Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoteAccessRoutingDomain.CipherTransformConstant

Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoteAccessRoutingDomain.EncryptionMethod

Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoteAccessRoutingDomain.IntegrityCheckMethod

Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoteAccessRoutingDomain.PfsGroup

Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoteAccessRoutingDomain.DHGroup

Outputs

CimInstance

CimInstance