Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Set-DnsServerSigningKey

Brian Lich|Last Updated: 3/28/2017

SYNOPSIS

Changes settings of a signing key.

SYNTAX

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

DESCRIPTION

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

EXAMPLES

Example 1: Retire signing keys during the next rollover

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

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 passes the results to the Set-DnsServerSigningKey cmdlet by using the pipeline operator.

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

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
Parameter Sets: (All)
Aliases: 

Required: False
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[]
Parameter Sets: (All)
Aliases: Session

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ComputerName

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.

Type: String
Parameter Sets: (All)
Aliases: Cn

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-DSSignatureValidityPeriod

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

Type: TimeSpan
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DnsKeySignatureValidityPeriod

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

Type: TimeSpan
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-KeyId

Specifies the unique identifier of a key.

Type: Guid
Parameter Sets: (All)
Aliases: 

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NextRolloverAction

Specifies the next rollover action.

Type: String
Parameter Sets: (All)
Aliases: 
Accepted values: Normal, RevokeStandby, Retire

Required: False
Position: Named
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
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
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
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ZoneName

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

Type: String
Parameter Sets: (All)
Aliases: 

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

-ZoneSignatureValidityPeriod

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

Type: TimeSpan
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

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

INPUTS

OUTPUTS

Microsoft.Management.Infrastructure.CimInstance#DnsServerSigningKey

NOTES

Get-DnsServerSigningKey

Add-DnsServerSigningKey

Remove-DnsServerSigningKey

Disable-DnsServerSigningKeyRollover

Enable-DnsServerSigningKeyRollover

Invoke-DnsServerSigningKeyRollover

© 2017 Microsoft