Export (0) Print
Expand All
Expand Minimize

Step-DnsServerSigningKeyRollover

Windows Server 2012 R2 and Windows 8.1

Updated: May 20, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Step-DnsServerSigningKeyRollover

Rolls over a KSK that is waiting for a parent DS update.

Syntax

Parameter Set: Step3
Step-DnsServerSigningKeyRollover [-ZoneName] <String> [-KeyId] <Guid> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-Force] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Step-DnsServerSigningKeyRollover cmdlet rolls over a key signing key (KSK) that is waiting for an update from a parent delegation signer (DS). If a server that hosts a securely delegated zone cannot check whether the DS record in a parent is updated, use this cmdlet to force a rollover.

Important: You must manually update the DS record in the parent before you run this cmdlet.

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.


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

-ComputerName<String>

Specifies a remote DNS server. Specify the IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name, for the DNS server.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Force

Forces the command to run without asking for user confirmation.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-KeyId<Guid>

Specifies the ID of the key for which to perform the KSK rollover.


Aliases

none

Required?

true

Position?

3

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.


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 the name of the DNS zone in which the cmdlet performs the KSK rollover.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

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.

  • The output object contains the following fields:

    ActiveKey
    CryptoAlgorithm
    CurrentRolloverStatusCurrentState
    DnsKeySignatureValidityPeriod
    DSSignatureValidityPeriodInitialRolloverOffset
    KeyId
    KeyLengthKeyStorageProvider
    KeyType
    LastRolloverTime
    NextKey
    NextRolloverAction
    NextRolloverTime
    RolloverPeriod
    RolloverType
    StandbyKey
    StoreKeysInAD
    ZoneName
    ZoneSignatureValidityPeriod


Examples

Example 1: Force a key signing key rollover

This example gets keys for a signed zone, and then forces a KSK rollover for one of the keys in the zone.


 

The first command uses the Get-DnsServerSigningKey cmdlet to gets keys for the signed zone Sec.Contoso.com.


PS C:\> Get-DnsServerSigningKey -ZoneName "Sec.Contoso.com"
KeyId                                  KeyType         CryptoAlgorithm    KeyLength  StoreKeysInAD   IsRolloverEnabled
----- ------- --------------- --------- ------------- -----------------
5fe47b29-6bf8-457a-b457-e640893ebd53 KeySigningKey RsaSha256 2048 True True
aaf3301e-feb2-4ba7-8ac6-273c6bda75af KeySigningKey RsaSha1NSec3 2048 True True
fbf3116f-b0ba-4bf8-bf35-68dab6d4765b ZoneSigningKey RsaSha1NSec3 1024 True True
f760fcb5-577b-4237-b0b2-513e1f68ec72 ZoneSigningKey RsaSha256 1024 True True

 

The last command forces a KSK rollover that is waiting for a parent DS update on Contoso.com. The command performs a KSK rollover for the specified key in the zone named Sec.Contoso.com.


PS C:\> Step-DnsServerSigningKeyRollover -KeyId 5fe47b29-6bf8-457a-b457-e640893ebd53 -ZoneName "Sec.Contoso.com" -Force

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft