Set-DnsServerSigningKey

Set-DnsServerSigningKey

Changes settings of a signing key.

Syntax

Parameter Set: Set3
Set-DnsServerSigningKey [-ZoneName] <String> [-KeyId] <Guid> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-DnsKeySignatureValidityPeriod <TimeSpan> ] [-DSSignatureValidityPeriod <TimeSpan> ] [-NextRolloverAction <String> ] [-PassThru] [-RolloverPeriod <TimeSpan> ] [-ThrottleLimit <Int32> ] [-ZoneSignatureValidityPeriod <TimeSpan> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-DnsServerSigningKey cmdlet changes settings of a signing key for a zone. You must specify the ZoneName parameter and at least one of the optional parameters.

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. You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name.

-DnsKeySignatureValidityPeriod<TimeSpan>

Specifies the amount of time that signatures that cover DNSKEY record sets are valid.

-DSSignatureValidityPeriod<TimeSpan>

Specifies the amount of time that signatures that cover DS record sets are valid.

-KeyId<Guid>

Specifies the unique identifier of a key.

-NextRolloverAction<String>

Specifies the next rollover action.

-PassThru

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

-RolloverPeriod<TimeSpan>

Specifies the amount of time between scheduled key rollovers.

-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 zone in which DNS Security Extensions (DNSSEC) operations are performed.

-ZoneSignatureValidityPeriod<TimeSpan>

Specifies the amount of time that signatures that cover all other record sets are valid.

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

• Microsoft.Management.Infrastructure.CimInstance#DnsServerSigningKey

Examples

Example 1: Retire signing keys during the next rollover

This command retires the signing keys of a zone during the next rollover. The Get-DnsServerSigningKey cmdlet gets the signing keys for the zone that is named sec.contoso.com and pipes the results to the Set-DnsServerSigningKey cmdlet.

Set-DnsServerSigningKey specifies that the signing keys will be retired during the next rollover.

PS C:\> Get-DnsServerSigningKey -ZoneName "sec.contoso.com" | Set-DnsServerSigningKey -NextRolloverAction "Retire"

Related topics

Get-DnsServerSigningKey

Add-DnsServerSigningKey

Remove-DnsServerSigningKey

Disable-DnsServerSigningKeyRollover

Enable-DnsServerSigningKeyRollover

Invoke-DnsServerSigningKeyRollover