Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Reset-DnsServerZoneKeyMasterRole

Reset-DnsServerZoneKeyMasterRole

ps_dnsserverzonekeymasterrole_v1.0.0.cdxml

Synopsis

Transfers the role of Key Master for a DNS zone.

Syntax

Reset-DnsServerZoneKeyMasterRole [-ZoneName] [-KeyMasterServer] [-AsJob] [-CimSession] [-Force] [-PassThru] [-SeizeRole] [-ThrottleLimit] [-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 <SwitchParameter>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

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

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

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

Aliases

None

Required?

false

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-SeizeRole <SwitchParameter>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ZoneName <String>

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

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

System.String

Notes

None

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

Online Version