Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-DnsServerConditionalForwarderZone

Add-DnsServerConditionalForwarderZone

ps_dnsserverconditionalforwarder_v1.0.0.cdxml

Synopsis

Adds a conditional forwarder to a DNS server.

Syntax

Add-DnsServerConditionalForwarderZone [-Name] [-MasterServers] [-ForwarderTimeout] [-AsJob] [-CimSession] [-ComputerName] [-LoadExisting] [-PassThru] [-ThrottleLimit] [-UseRecursion] [-Confirm] [-WhatIf] [<CommonParameters>]

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

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

Parameters

-AsJob <SwitchParameter>

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

-ComputerName <String>

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.

Aliases

Cn

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-DirectoryPartitionName <String>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ForwarderTimeout <UInt32>

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.

Aliases

None

Required?

false

Position

4

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-LoadExisting <SwitchParameter>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-MasterServers <IPAddress[]>

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.

Aliases

None

Required?

true

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

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

Aliases

ZoneName

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ReplicationScope <String>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

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

-UseRecursion <SwitchParameter>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

Microsoft.Management.Infrastructure.CimInstance#DnsServerConditionalForwarderZone

Notes

None

Examples

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

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.

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

Example 2: Create an Active Directory- integrated forwarder

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.

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

Online Version
Set-DnsServerConditionalForwarderZone