Reset-DnsServerZoneKeyMasterRole

Reset-DnsServerZoneKeyMasterRole

Transfers the role of Key Master for a DNS zone.

Syntax

Parameter Set: Reset0
Reset-DnsServerZoneKeyMasterRole [-ZoneName] <String> [[-KeyMasterServer] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-PassThru] [-SeizeRole] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Reset-DnsServerZoneKeyMasterRole cmdlet transfers the role of DNS Security (DNSSEC) Key Master server. Any authoritative Domain Name System (DNS) server that hosts a primary copy of the zone can be the Key Master server.

This cmdlet attempts to connect to the current Key Master server. If it cannot connect to that server, the cmdlet does not make the change unless you specify SeizeRole.

This cmdlet prompts the user for confirmation before it transfers the role unless you use the Force switch.

Parameters

-AsJob

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

-Force

Transfers the role without prompting you for confirmation. By default, the cmdlet prompts you for confirmation before it proceeds.

-KeyMasterServer<String>

Specifies the name of a DNS server. Use a NetBIOS name, IP address, or fully qualified domain name. The cmdlet makes this server the Key Master server for the specified zone. The specified zone must be present on the DNS server as a primary zone.

-PassThru

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

-SeizeRole

Seizes the Key Master role. Unless this switch is specified, the cmdlet does not make a change if it cannot reach the current Key Master server.

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

-ZoneName<String>

Specifies a name of a zone. The cmdlet transfers the Key Master role for this zone.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• System.String

Examples

Example 1: Transfer the role

This command transfers the Key Master role for the zone named west01.contoso.com to the server named keys.contoso.com. If the cmdlet cannot verify with the current Key Master server, it does not transfer the role.

PS C:\> Reset-DnsServerZoneKeyMasterRole -ZoneName "west01.contoso.com" -KeyMasterServer "root.contoso.com" 

Example 2: Transfer the role, required

This command transfers the Key Master role for the zone named west01.contoso.com to a server named keys.contoso.com. If the cmdlet cannot verify with the current Key Master server, the cmdlet nevertheless transfers the role.

PS C:\> Reset-DnsServerZoneKeyMasterRole -ZoneName "west01.contoso.com" -KeyMasterServer "keys.contoso.com" -SeizeRole