Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Add-VpnConnectionTriggerDnsConfiguration

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Add-VpnConnectionTriggerDnsConfiguration

Adds a DNS suffix or name to VPN connection trigger properties.

Syntax

Parameter Set: Add0
Add-VpnConnectionTriggerDnsConfiguration [-ConnectionName] <String> [-DnsSuffix] <String> [[-DnsIPAddress] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Add-VpnConnectionTriggerDnsConfiguration cmdlet adds a Domain Name System (DNS) suffix or name to the DNS trigger properties for a client. If you specify a DNS IP address for the suffix or name, when the client accesses a resource within the suffix, the client starts a virtual private network (VPN) connection. If you do not specify a DNS IP address for a DNS suffix or name, accessing the suffix or name does not trigger the VPN connection.

If you previously ran the Set-VpnConnectionTriggerTrustedNetwork cmdlet with the DefaultDnsSuffixes parameter specified, the current cmdlet adds the DNS suffix to the trusted Network list. This cmdlet does not add DNS suffixes that do not have DNS server addresses.

Parameters

-AsJob

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

-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

-ConnectionName<String>

Specifies the name of a VPN connection profile. To view existing VPN connection profiles, use the Get-VpnConnection cmdlet.


Aliases

Name

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DnsIPAddress<String[]>

Specifies an array IP addresses of DNS servers for the DNS suffix. You can use both IPv4 and IPv6 addresses.

If you do not specify a DNS server, the client does not start a VPN connection when the client accesses a resource with the DNS suffix or name.


Aliases

none

Required?

false

Position?

4

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DnsSuffix<String>

Specifies a DNS suffix.


Aliases

none

Required?

true

Position?

3

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. If you specify this parameter, the cmdlet returns the VpnConnectionTriggerDnsConfiguration object that contains DNS suffixes and corresponding DNS servers.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

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

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

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#VpnConnectionTriggerDnsConfiguration

Examples

Example 1: Add a DNS suffix

This command adds the DNS suffix Washington.Contoso.com to the trigger properties for the current client. The command specifies the VPN connection profile named Contoso and an address for a DNS server for this suffix. The command includes the PassThru parameter. Therefore, it returns the VPN connection DNS trigger properties for the client.

In this example, Trigger Trusted Network has the default value, so the command adds the suffix to the trusted network detection list.


PS C:\> Add-VpnConnectionTriggerDnsConfiguration -ConnectionName "Contoso" -DnsSuffix "Washington.Contoso.com" -DnsIPAddress "172.16.12.23" -PassThru
              

WARNING: The suffix Washington.Contoso.com will be automatically added to
the trusted network detection list. Any subsequent addition/removal of
suffixes from this cmdlet will be reflected in the trusted network
detection list. If you do not want this auto-population, remove the
suffixes from the trusted network detection list by using the
cmdlet Remove-VpnConnectionTriggerTrustedNetwork


ConnectionName DnsSuffix DnsIPAddress DnsSuffixSearchList

-------------- --------- ------------ -------------------

Contoso Washington.Contos... {172.16.12.23}

Example 2: Add a DNS suffix that has multiple DNS servers

This command adds the DNS suffix NewYork.Contoso.com to the trigger properties for the current client. The command specifies the VPN connection profile named Contoso and multiple addresses for DNS servers. The command includes the PassThru parameter. Therefore, it returns the VPN connection DNS trigger properties for the client.


PS C:\> Add-VpnConnectionTriggerDnsConfiguration -ConnectionName "Contoso" -DnsSuffix "NewYork.Contoso.com" -DnsIPAddress "172.16.12.3", "172.16.12.22" -PassThru
ConnectionName       DnsSuffix            DnsIPAddress                             DnsSuffixSearchList

-------------- --------- ------------ -------------------

Contoso NewYork.Contoso.com {172.16.12.3, 172.16.12.22}

Example 3: Add a DNS suffix that does not trigger a VPN connection

This command adds the DNS suffix RAS.Washington.Contoso.com to the trigger properties for the current client. The command specifies the VPN connection profile named Contoso. Unlike the previous examples, this command does not specify an address for a DNS server. When this client accesses resources from RAS.Washington.Contoso.com, it does not trigger a VPN connection. The command includes the PassThru parameter. Therefore, it returns the VPN connection DNS trigger properties for the client.


PS C:\> Add-VpnConnectionTriggerDnsConfiguration -ConnectionName "Contoso" -DnsSuffix "RAS.Washington.Contoso.com" -PassThru
ConnectionName       DnsSuffix            DnsIPAddress                             DnsSuffixSearchList

-------------- --------- ------------ -------------------

Contoso RAS.Washington.Co...

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.