Set-DnsServerPrimaryZone

  • Reference
Module:
DnsServer

Changes settings for a DNS primary zone.

Syntax

Set-DnsServerPrimaryZone
   [-Name] <String>
   [-ComputerName <String>]
   [-PassThru]
   [-AllowedDcForNsRecordsAutoCreation <String[]>]
   [-DynamicUpdate <String>]
   [-Notify <String>]
   [-NotifyServers <IPAddress[]>]
   [-SecondaryServers <IPAddress[]>]
   [-SecureSecondaries <String>]
   [-IgnorePolicies <Boolean>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-DnsServerPrimaryZone
   [-Name] <String>
   [-ComputerName <String>]
   [-PassThru]
   -ZoneFile <String>
   [-VirtualizationInstance <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-DnsServerPrimaryZone
   [-Name] <String>
   [-ComputerName <String>]
   [-PassThru]
   -ReplicationScope <String>
   [-DirectoryPartitionName <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-DnsServerPrimaryZone cmdlet changes settings for an existing Domain Name System (DNS) primary zone. You can change values that are relevant for either Active Directory-integrated zones or file-backed zones.

Examples

Example 1: Change the dynamic update setting

PS C:\> Set-DnsServerPrimaryZone -Name "western.contoso.com" -DynamicUpdate "NonsecureAndSecure" -PassThru

ZoneName                            ZoneType        IsAutoCreated   IsDsIntegrated  IsReverseLookupZone  IsSigned
--------                            --------        -------------   --------------  -------------------  --------
western.contoso.com                 Primary         False           True            False                False

This command changes the dynamic update setting to NonsecureAndSecure for the zone named western.contoso.com. The example uses the PassThru parameter to return output.

Example 2: Change the replication scope

PS C:\> Set-DnsServerPrimaryZone -Name "western.contoso.com" -ReplicationScope "Forest" -PassThru

ZoneName                            ZoneType        IsAutoCreated   IsDsIntegrated  IsReverseLookupZone  IsSigned
--------                            --------        -------------   --------------  -------------------  --------
western.contoso.com                 Primary         False           True            False                False

This command changes the replication scope of the zone named western.contoso.com. The example uses the PassThru parameter to return output.

Example 3: Change the name for the zone file

PS C:\> Set-DnsServerPrimaryZone -Name "western.contoso.com" -ZoneFile "tet23.dns" -PassThru

ZoneName                            ZoneType        IsAutoCreated   IsDsIntegrated  IsReverseLookupZone  IsSigned
--------                            --------        -------------   --------------  -------------------  --------
western.contoso.com                 Primary         False           False           False                False

This command changes the file name for the zone file for the zone western.contoso.com. The example uses the PassThru parameter to return output.

Parameters

-AllowedDcForNsRecordsAutoCreation

Specifies IP addresses of domain controllers that add their names in Name Server (NS) resource records for the zone.

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

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

-DynamicUpdate

Specifies how a zone accepts dynamic updates. Servers that accept dynamic updates can receive client registration requests. The acceptable values for this parameter are:

  • None
  • Secure
  • NonsecureAndSecure

DNS update security is available only for Active Directory-integrated zones.

Type:String
Accepted values:None, Secure, NonsecureAndSecure
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-IgnorePolicies

Indicates whether to ignore policies for this zone.

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

-Name

Specifies the name of a zone.

Type:String
Aliases:ZoneName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Notify

Specifies how a DNS master server notifies secondary servers of changes to resource records. The acceptable values for this parameter are:

  • NoNotify. The zone does not send change notifications to secondary servers.
  • Notify. The zone sends change notifications to all secondary servers.
  • NotifyServers. The zone sends change notifications to some secondary servers. If you choose this option, specify the list of secondary servers in the NotifyServers parameter.
Type:String
Accepted values:NoNotify, Notify, NotifyServers
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-NotifyServers

Specifies an array of IP addresses of secondary DNS servers that the DNS master server notifies of changes to resource records. You need this parameter only if you selected the value NotifyServers for the Notify parameter.

Type:IPAddress[]
Position:Named
Default value:None
Required:False
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 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
Accepted values:Forest, Domain, Legacy, Custom
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SecondaryServers

Specifies an array of IP addresses of DNS servers that are allowed to receive this zone through zone transfers.

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

-SecureSecondaries

Specifies how a DNS master server allows zone transfers to secondary servers. You can configure the DNS server to send zone transfers only certain servers. If other servers request zone transfers, the DNS server rejects the requests.

The acceptable values for this parameter are:

  • NoTransfer. Zone transfers are not allowed on this DNS server for this zone.
  • TransferAnyServer. Zone transfers are allowed to any DNS server.
  • TransferToZoneNameServer. Zone transfers are allowed only to servers in the name servers (NS) records for this zone.
  • TransferToSecureServers. Zone transfers are allowed only for secondary servers.
Type:String
Accepted values:NoTransfer, TransferAnyServer, TransferToZoneNameServer, TransferToSecureServers
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

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

Type:String
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

-ZoneFile

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

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

Outputs

CimInstance