Set-DnsServerPrimaryZone

Changes settings for a DNS primary zone.

Syntax

Parameters (Default)

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

FileZone

Set-DnsServerPrimaryZone
    [-Name] <String>
    -ZoneFile <String>
    [-ComputerName <String>]
    [-PassThru]
    [-VirtualizationInstance <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ADZone

Set-DnsServerPrimaryZone
    [-Name] <String>
    -ReplicationScope <String>
    [-ComputerName <String>]
    [-PassThru]
    [-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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

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

ADZone
Position:Named
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. 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.

Parameter properties

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

Parameter sets

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

-IgnorePolicies

Indicates whether to ignore policies for this zone.

Parameter properties

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

Parameter sets

Parameters
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of a zone.

Parameter properties

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

Parameter sets

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

Parameter properties

Type:String
Default value:None
Accepted values:NoNotify, Notify, NotifyServers
Supports wildcards:False
DontShow:False

Parameter sets

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

Parameter properties

Type:

IPAddress[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Parameters
Position:Named
Mandatory:False
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

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

-SecondaryServers

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

Parameter properties

Type:

IPAddress[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

Parameter properties

Type:String
Default value:None
Accepted values:NoTransfer, TransferAnyServer, TransferToZoneNameServer, TransferToSecureServers
Supports wildcards:False
DontShow:False

Parameter sets

Parameters
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

FileZone
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 the name of the zone file. This parameter is relevant only for file-backed DNS.

Parameter properties

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

Parameter sets

FileZone
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