Edit

Share via


Add-DnsServerPrimaryZone

Adds a primary zone to a DNS server.

Syntax

ADForwardLookupZone (Default)

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

FileReverseLookupZone

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

FileForwardLookupZone

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

ADReverseLookupZone

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

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.

Examples

Example 1: Create a primary zone

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

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

Example 2: Create a file-backed primary zone

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

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

Example 3: Create a reverse lookup zone

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

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

Example 4: Create a file-backed reverse lookup zone

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

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

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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ComputerName

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Cn

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DirectoryPartitionName

Specifies a directory partition on which to store the zone. Use this parameter when the ReplicationScope parameter has a value of Custom.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ADForwardLookupZone
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DynamicUpdate

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.

Parameter properties

Type:String
Default value:None
Accepted values:None, Secure, NonsecureAndSecure
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-LoadExisting

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Name

Specifies a name for the zone the cmdlet creates.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ZoneName

Parameter sets

ADForwardLookupZone
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
FileForwardLookupZone
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-NetworkId

Specifies a network ID and prefix length for a reverse lookup zone. Use the format A.B.C.D/prefix for IPv4 or 1111:2222:3333:4444::/prefix for IPv6.

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

For IPv6, the cmdlet creates ip6.arpa zones for prefixes from /16 to /128 that are divisible by 4. If you specify a prefix that is between values, the cmdlet uses the longer prefix that is divisible by 4. For example, entering a value of AAAA::/58 adds the AAAA::/60 ip6.arpa zone. If you do not enter a prefix, the cmdlet uses a default prefix value of /128.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

FileReverseLookupZone
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
ADReverseLookupZone
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PassThru

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReplicationScope

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.

Parameter properties

Type:String
Default value:None
Accepted values:Forest, Domain, Legacy, Custom
Supports wildcards:False
DontShow:False

Parameter sets

ADForwardLookupZone
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
ADReverseLookupZone
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ResponsiblePerson

Specifies a person responsible for the zone.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VirtualizationInstance

Specifies the virtualization instance in which the zone will be added. A virtualization instance is logical partition in a DNS Server, which is capable of independently hosting zones and zone scopes. Same name zones and zone scopes can be hosted in different virtualization instances. This parameter is optional and if not provided it will add the zone into the default virtualization instance which is functionally equivalent to a standard DNS server.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

FileReverseLookupZone
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
FileForwardLookupZone
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ZoneFile

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

FileReverseLookupZone
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
FileForwardLookupZone
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

CimInstance