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

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

Set-VpnConnectionTriggerDnsConfiguration

Changes DNS servers for an existing DNS suffix.

Syntax

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




Detailed Description

The Set-VpnConnectionTriggerDnsConfiguration cmdlet changes Domain Name System (DNS) servers for an existing DNS suffix associated with a virtual private network (VPN) connection. This cmdlet also configures the DNS suffix search list for a VPN connection.

If you specify a DNS IP address for a suffix, when a client accesses a resource within that suffix, the client starts a VPN connection. You can specify a list of DNS suffixes for a client to append to short names to attempt connections by using a specified VPN connection.

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 specify an empty string, when the client accesses a resource within the DNS suffix, it does not trigger a VPN connection.


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?

false

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DnsSuffixSearchList<String[]>

Specifies an array of DNS suffixes. The client appends a suffix to a short name to create a fully qualified domain name (FQDN). The client tries the suffixes on this list to see if any of them, appended to a short name, identify a resource.


Aliases

none

Required?

false

Position?

5

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Force

Indicates that the cmdlet makes changes to the VPN connection trigger DNS configuration without a confirmation message.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

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, and the DNS suffix search list.


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: Change the DNS server for a DNS suffix

This command changes the IP address for the DNS server for a DNS suffix to a value of 172.16.12.3. Use the DnsIPAddress parameter to specify the new value. The command specifies the VPN connection profile named Contoso and the DNS suffix Washington.Contoso.com. The command includes the PassThru parameter. Therefore, it returns the VPN connection DNS trigger properties for the client. Because the command includes the Force parameter, it does not prompt the user for confirmation.


PS C:\> Set-VpnConnectionTriggerDnsConfiguration -ConnectionName "Contoso" -DnsSuffix "Washington.Contoso.com" -DnsIPAddress "172.16.12.3" -PassThru -Force
ConnectionName       DnsSuffix            DnsIPAddress                             DnsSuffixSearchList

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

Contoso Washington.Contos... {207.64.32.54}

Example 2: Change the DNS suffix search list for a VPN connection

This command changes the DNS suffix search list for the VPN connection profile named Contoso to be the two specified DNS suffixes. The command includes the PassThru parameter. Therefore, it returns the VPN connection DNS trigger properties for the client. Because the command includes the Force parameter, it does not prompt the user for confirmation.


PS C:\> Set-VpnConnectionTriggerDnsConfiguration -ConnectionName "Contoso" -DnsSuffixSearchList "Corp.Contoso.com", "Sales.Contoso.com" -PassThru -Force
ConnectionName       DnsSuffix            DnsIPAddress                             DnsSuffixSearchList

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

Contoso {Corp.Contoso.com, Sales.Contoso....

Related topics

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