Set-DnsServerConditionalForwarderZone

Changes settings for a DNS conditional forwarder.

Syntax

Set-DnsServerConditionalForwarderZone
   [-Name] <String>
   [-ComputerName <String>]
   [-PassThru]
   [-DirectoryPartitionName <String>]
   -ReplicationScope <String>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-DnsServerConditionalForwarderZone
   [-Name] <String>
   [-ComputerName <String>]
   [-PassThru]
   [[-UseRecursion] <Boolean>]
   [[-MasterServers] <IPAddress[]>]
   [[-ForwarderTimeout] <UInt32>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-DnsServerConditionalForwarderZone cmdlet changes settings of an existing conditional forwarder on a Domain Name System (DNS) server. You can change the master servers, forwarder time-out, recursion, recursion scope, and directory partition name for a conditional forwarder zone.

Examples

Example 1: Change forwarder time-out for a zone

PS C:\> Set-DnsServerConditionalForwarderZone -Name "contoso.com" -ForwarderTimeout 15

This command changes the forwarder time-out for a forwarder zone named contoso.com.

Example 2: Change replication scope for a zone

PS C:\> Set-DnsServerConditionalForwarderZone -Name "contoso.com" -ReplicationScope "Domain" -PassThru

This command changes the replication scope of contoso.com to a value of Domain, which means all DNS servers in the domain. This example uses the PassThru parameter to create output.

Required Parameters

-Name

Specifies the name of a zone that has conditional forwarding configured.

Type:String
Aliases:ZoneName
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ReplicationScope

Specifies the replication scope for the conditional forwarder. Conditional forwarders are stored internally as zones. The acceptable values for this parameter are:

  • Custom. Replicate the conditional forwarder to all DNS servers running on domain controllers enlisted in a custom directory partition.
  • Domain. Replicate the conditional forwarder to all DNS servers that run on domain controllers in the domain.
  • Forest. Replicate the conditional forwarder to all DNS servers that run on domain controllers in the forest.
  • Legacy. Replicate the conditional forwarder to all domain controllers in the domain.
Type:String
Parameter Sets:Forest, Domain, Legacy, Custom
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional 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.

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

Specifies a DNS server to host the forwarder. If you do not specify this parameter, the command runs on the local system. You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name.

Type:String
Aliases:Cn
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-DirectoryPartitionName

Specifies a directory partition on which to store the forwarder. Conditional forwarders are internally stored as zones. Use this parameter when the ReplicationScope parameter has a value of Custom.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ForwarderTimeout

Specifies a length of time, in seconds, that a DNS server waits for the forwarder to resolve a query. After the DNS server tries all forwarders, it can attempt to resolve the query itself. The minimum value is 0. The maximum value is 15.

Type:UInt32
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-MasterServers

Specifies an array of IP addresses of the master servers of the zone. Conditional forwarders are stored as zones. You can use both IPv4 and IPv6 addresses. Specify at least one master server.

Type:IPAddress[]
Position:2
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.

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

Specifies whether a DNS server attempts to resolve a query after the forwarder fails to resolve it. A value of $False prevents a DNS server from attempting resolution using other DNS servers. This parameter overrides the Use Recursion setting for a DNS server.

Type:Boolean
Position:4
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.Management.Infrastructure.CimInstance#DnsServerConditionalForwarderZone