Remove-VpnConnectionTriggerDnsConfiguration

  • Reference
Module:
VpnClient

Removes DNS suffixes from VPN connection DNS trigger properties.

Syntax

Remove-VpnConnectionTriggerDnsConfiguration
      [-ConnectionName] <String>
      [-DnsSuffix] <String[]>
      [-PassThru]
      [-Force]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-VpnConnectionTriggerDnsConfiguration cmdlet removes Domain Name System (DNS) suffixes from the DNS trigger properties for a virtual private network (VPN) connection. After you remove a DNS suffix, if the client accesses any resource that is part of the DNS suffix, accessing that resource does not trigger a VPN connection. VPN connection DNS trigger properties determine whether a client automatically starts an existing VPN connection.

If you previously ran the Set-VpnConnectionTriggerTrustedNetwork cmdlet with the DefaultDnsSuffixes parameter specified, the current cmdlet also removes the DNS suffixes from the trusted network list.

Examples

Example 1: Remove DNS suffixes for a connection

PS C:\>Remove-VpnConnectionTriggerDnsConfiguration -ConnectionName "Contoso" -DnsSuffix "washington.contoso.com", "newyork.contoso.com" -Force

This command removes the DNS suffixes washington.contoso.com and newyork.contoso.com for the VPN connection profile named Contoso. Because the command includes the Force parameter, it does not prompt you for confirmation.

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
Required:False
Accept pipeline input:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionName

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

Type:String
Aliases:Name
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DnsSuffix

Specifies an array of DNS suffixes.

Type:String[]
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Force

Indicates that the cmdlet removes DNS suffixes from the VPN connection trigger DNS configuration without a confirmation message.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

CimInstance