Step-DnsServerSigningKeyRollover

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

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

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

-Force

Forces the command to run without asking for user confirmation.

-KeyId<Guid>

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

-PassThru

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

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

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

• 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"

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

Enable-DnsServerSigningKeyRollover

Invoke-DnsServerSigningKeyRollover

Disable-DnsServerSigningKeyRollover