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

Add-DnsServerPrimaryZone

ps_dnsserverprimaryzone_v1.0.0.cdxml

Synopsis

Adds a primary zone to a DNS server.

Syntax

Add-DnsServerPrimaryZone [-Name] [-ReplicationScope] [-DirectoryPartitionName] [-AsJob] [-CimSession] [-ComputerName] [-DynamicUpdate] [-LoadExisting] [-PassThru] [-ResponsiblePerson] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Add-DnsServerPrimaryZone [-AsJob] [-CimSession] [-ComputerName] [-DynamicUpdate] [-LoadExisting] [-PassThru] [-ResponsiblePerson] [-ThrottleLimit] [-NetworkId] [-ZoneFile] [-Confirm] [-WhatIf] [<CommonParameters>]

Add-DnsServerPrimaryZone [-ReplicationScope] [-DirectoryPartitionName] [-AsJob] [-CimSession] [-ComputerName] [-DynamicUpdate] [-LoadExisting] [-PassThru] [-ResponsiblePerson] [-ThrottleLimit] [-NetworkId] [-Confirm] [-WhatIf] [<CommonParameters>]

Add-DnsServerPrimaryZone [-Name] [-AsJob] [-CimSession] [-ComputerName] [-DynamicUpdate] [-LoadExisting] [-PassThru] [-ResponsiblePerson] [-ThrottleLimit] [-ZoneFile] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Add-DnsServerPrimaryZone cmdlet adds a specified primary zone on a Domain Name System (DNS) server.

You can add an Active Directory-integrated forward lookup zone, an Active Directory-integrated reverse lookup zone, a file-backed forward lookup zone, or a file-backed reverse lookup zone.

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 a DNS 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 zone. Use this parameter when the ReplicationScope parameter has a value of Custom.

Aliases

None

Required?

false

Position

4

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DynamicUpdate <String>

Specifies how a zone accepts dynamic updates. The acceptable values for this parameter are:  -- None -- Secure -- NonsecureAndSecure

Secure DNS updates are available only for Active Directory-integrated zones.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-LoadExisting <SwitchParameter>

Loads an existing file for the zone. Otherwise, the cmdlet creates default zone records automatically. This switch is relevant only for file-backed zones.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Specifies a name for the zone the cmdlet creates.

Aliases

ZoneName

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-NetworkId <String>

Specifies a network ID and prefix length for a reverse lookup zone. Use the format A.B.C.D/prefix.

The cmdlet creates only class A, B, C, or D zones. If you specify a prefix that is between classes, the cmdlet uses the longer prefix divisible by 8. For example, a value of 10.2.10.0/23 results in the 10.2.10.0/24 reverse lookup zone, not the 10.2.11.0/24 reverse lookup zone. If you enter a prefix longer than /24, the cmdlet creates a /32 reverse lookup zone.

Aliases

None

Required?

true

Position

named

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 a partition on which to store an Active Directory-integrated zone. The acceptable values for this parameter are:  -- Custom. Any custom directory partition that a user creates. Specify a custom directory partition by using the DirectoryPartitionName parameter. -- Domain. The domain directory partition. -- Forest. The ForestDnsZone directory partition. -- Legacy. A legacy directory partition.

Aliases

None

Required?

true

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ResponsiblePerson <String>

Specifies a person responsible for the zone.

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

-ZoneFile <String>

Specifies a name of the zone file. This parameter is only relevant for file-backed zones.

Aliases

None

Required?

true

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

Notes

None

Examples

Example 1: Create a primary zone

This command creates an Active Directory-integrated forward lookup zone called west01.contoso.com with Forest-wide replication scope.

PS C:\> Add-DnsServerPrimaryZone -Name "west01.contoso.com" -ReplicationScope "Forest" -PassThru 

Example 2: Create a file-backed primary zone

This command creates a file-backed primary forward lookup zone called west02.contoso.com with the specified DNS file.

PS C:\>Add-DnsServerPrimaryZone -Name "west02.contoso.com" -ZoneFile "west02.contoso.com.dns"

Example 3: Create a reverse lookup zone

This command creates the Active Directory-integrated class C reverse lookup zone 0.1.10.in-addr.arpa with Forest-wide replication scope.

PS C:\>Add-DnsServerPrimaryZone -NetworkID "10.1.0.0/24" -ReplicationScope "Forest" 
ZoneName                            ZoneType        IsAutoCreated   IsDsIntegrated  IsReverseLookupZone  IsSigned

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

1.10.in-addr.arpa                   Primary         False           True            True                 False

Example 4: Create a file-backed reverse lookup zone

This command creates the file-backed reverse lookup zone 0.3.10.in-addr.arpa.

PS C:\>Add-DnsServerPrimaryZone -NetworkID 10.3.0.0/24 -ZoneFile "0.3.10.in-addr.arpa.dns" 

Online Version
ConvertTo-DnsServerPrimaryZone
Restore-DnsServerPrimaryZone
Set-DnsServerPrimaryZone