Add-DnsServerConditionalForwarderZone

  • Reference
Module:
DnsServer

Adds a conditional forwarder to a DNS server.

Syntax

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

Description

The Add-DnsServerConditionalForwarderZone cmdlet adds a conditional forwarder to a Domain Name System (DNS) server. You can select the master servers, forwarder time-out, recursion, host computer, replication scope, and directory partition for the conditional forwarder. Conditional forwarders are stored as zones on a DNS server.

Examples

Example 1: Create a non-Active Directory-integrated forwarder

PS C:\> Add-DnsServerConditionalForwarderZone -Name "contoso.com" -MasterServers 2001:4898:7020:f100:458f:e6a2:fcaf:698c,172.23.90.124 -PassThru

ZoneName                            ZoneType        IsAutoCreated   IsDsIntegrated  IsReverseLookupZone  IsSigned
--------                            --------        -------------   --------------  -------------------  --------
contoso.com                         Forwarder       False           False           False

This command creates a conditional forwarder zone called contoso.com. The entries are stored in the registry. The command includes IP addresses for one or more master DNS servers. The command uses the PassThru parameter.

Example 2: Create an Active Directory-integrated forwarder

PS C:\> Add-DnsServerConditionalForwarderZone -Name "contoso.com" -ReplicationScope "Forest" -MasterServers 2001:4898:7020:f100:458f:e6a2:fcaf:698c,172.23.90.124

This command creates an Active Directory-integrated conditional forwarder zone for contoso.com. The command specifies IP addresses for one or more master DNS servers.

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

-ComputerName

Specifies the DNS server. The cmdlet adds the forwarder to this server. 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
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

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

-ForwarderTimeout

Specifies a length of time, in seconds, that a DNS server waits for a master server to resolve a query. If a server does not resolve the request, the next server in the list is queried until all master servers are queried. After this period, the DNS server can attempt to resolve the query itself. This parameter applies only to the forwarder zone. The minimum value is 0. The maximum value is 15.

Type:UInt32
Position:3
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-LoadExisting

Indicates that the server loads existing data for the forwarder from the registry. Conditional forwarders are internally stored as zones. This parameter is not valid for Active Directory-integrated zones.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MasterServers

Specifies an array of IP addresses of the master servers of the zone. DNS queries for a forwarded zone are sent to master servers. You can use both IPv4 and IPv6 addresses. You must specify at least one master server.

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

-Name

Specifies the name of a zone. The cmdlet adds a conditional forwarder for this zone.

Type:String
Aliases:ZoneName
Position:1
Default value:None
Required:True
Accept pipeline input:True
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
Required:False
Accept pipeline input:False
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
Accepted values:Forest, Domain, Legacy, Custom
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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

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