Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-RemoteAccessRoutingDomain

Set-RemoteAccessRoutingDomain

ps_remoteaccessroutingdomain_v1.0.cdxml

Synopsis

Configures S2S VPN settings for a routing domain configuration.

Syntax

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

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

Detailed Description

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

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

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

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

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

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

Input Type


Return Type

Microsoft.Management.Infrastructure.CimInstance#VpnRoutingDomainConfig

Notes

None

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


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




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


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




Online Version
Disable-RemoteAccessRoutingDomain
Enable-RemoteAccessRoutingDomain
Get-RemoteAccessRoutingDomain