Convert To-Dns Server Primary Zone

Module:
dnsserver
Converts a zone to a DNS primary zone.

Syntax 

ConvertTo-DnsServerPrimaryZone
         [-ComputerName <String>]
         [-Name] <String>
         [-LoadExisting]
         [-PassThru]
         [-Force]
         [-ReplicationScope] <String>
         [[-DirectoryPartitionName] <String>]
         [-CimSession <CimSession[]>]
         [-ThrottleLimit <Int32>]
         [-AsJob]
         [-WhatIf]
         [-Confirm]
         [<CommonParameters>]
ConvertTo-DnsServerPrimaryZone
         [-ComputerName <String>]
         [-Name] <String>
         [-LoadExisting]
         [-PassThru]
         [-Force]
         -ZoneFile <String>
         [-CimSession <CimSession[]>]
         [-ThrottleLimit <Int32>]
         [-AsJob]
         [-WhatIf]
         [-Confirm]
         [<CommonParameters>]

Description

The ConvertTo-DnsServerPrimaryZone cmdlet converts a Domain Name System (DNS) zone to a DNS primary zone. Use this cmdlet to promote a secondary zone to a primary zone on the server. For a file-backed zone, ensure there is only one server that hosts the primary zone.

Examples

Example 1: Convert a file-backed zone 

PS C:\> ConvertTo-DnsServerPrimaryZone -Name "west03.contoso.com" -PassThru -Verbose -ZoneFile "west03.contoso.com" -Force 
VERBOSE: Convert west03.contoso.com zone to (file backed/AD integrated) DNS primary zone on DNS-11 server.
ZoneName                            ZoneType        IsAutoCreated   IsDsIntegrated  IsReverseLookupZone  IsSigned

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

west03.contoso.com                  Primary         False           False           False                False

This command converts zone named west03.contoso.com to a file-backed primary zone on the current server. This example uses the Force parameter to skip a confirmation message.

Example 2: Convert an Active Directory-integrated zone 

PS C:\> ConvertTo-DnsServerPrimaryZone "west04.contoso.com" -PassThru -Verbose -ReplicationScope Domain -Force

This command converts a zone named west04.contoso.com to an Active Directory-integrated primary zone. The zone will be replicated to all DNS servers in the domain. This example uses the Force parameter to skip a confirmation message.

Required Parameters

-Name

Specifies the name of a zone.

Type: String
Aliases: ZoneName
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: 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.
Type: String
Parameter Sets: Forest, Domain, Legacy, Custom
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ZoneFile

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

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

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

Converts a zone without prompting you for confirmation. By default, the cmdlet prompts you for confirmation before it proceeds.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LoadExisting

Indicates that the DNS server loads an existing file for the zone. If you do not specify this parameter, this cmdlet creates default zone records. This parameter is relevant only for file-backed zones.

Type: SwitchParameter
Position: Named
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
-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#DnsServerPrimaryZone