Enable-DnsServerSigningKeyRollover

Enables rollover on the input key.

Syntax

Enable-DnsServerSigningKeyRollover
      [-ZoneName] <String>
      [-KeyId] <Guid>
      [[-RolloverPeriod] <TimeSpan>]
      [[-InitialRolloverOffset] <TimeSpan>]
      [-AsJob]
      [-CimSession <CimSession[]>]
      [-ComputerName <String>]
      [-Confirm]
      [-Force]
      [-PassThru]
      [-ThrottleLimit <Int32>]
      [-WhatIf]
      [<CommonParameters>]

Description

The Enable-DNSServerSigningKeyRollover cmdlet enables rollover on the input key. For more information about Domain Name System (DNS) server signing keys, see the Key Management section of Overview of DNSSEC.

Examples

Example 1: Get keys and enable rollover

PS C:\> Get-DnsServerSigningKey -ZoneName "DNSServer06.Contoso.com" | Enable-DnsServerSigningKeyRollover

This command uses the Get-DnsServerSigningKey cmdlet to get keys for the DNSServer06.contoso.com zone. These keys are then passed to the Enable-DnsServerSigningKeyRollover cmdlet by using the pipeline operator. That cmdlet enables rollover for each key.

Required Parameters

-KeyId

Specifies the ID of a key.

Type:Guid
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ZoneName

Specifies the name of the zone in which DNS Security Extensions (DNSSEC) operations are performed.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters: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.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ComputerName

Specifies a DNS server. The acceptable values for this parameter are: an IP v4 address, an IP v6 address, and any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name.

Type:String
Aliases:Cn
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Force

Instructs the cmdlet to perform the operation without prompting for confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InitialRolloverOffset

Specifies the amount of time before the first scheduled key rollover occurs. You can stagger key rollovers by using this parameter.

Type:TimeSpan
Position:4
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.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RolloverPeriod

Specifies the amount of time between scheduled key rollovers.

Type:TimeSpan
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters: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.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.Management.Infrastructure.CimInstance#DnsServerSigningKey