Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-DnsServerSigningKey

Add-DnsServerSigningKey

ps_dnsserversigningkey_v1.0.0.cdxml

Synopsis

Adds a KSK or ZSK to a signed zone.

Syntax

Add-DnsServerSigningKey [-ZoneName] [-Type] [-CryptoAlgorithm] [-KeyLength] [-ActiveKey] [-AsJob] [-CimSession] [-ComputerName] [-DnsKeySignatureValidityPeriod] [-DSSignatureValidityPeriod] [-InitialRolloverOffset] [-KeyStorageProvider] [-NextKey] [-PassThru] [-RolloverPeriod] [-StandbyKey] [-StoreKeysInAD] [-ThrottleLimit] [-ZoneSignatureValidityPeriod] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Add-DnsServerSigningKey cmdlet adds a Key Signing Key (KSK) or Zone Signing Key (ZSK) key to a Domain Name System (DNS) signed zone.

Parameters

-ActiveKey <String>

Specifies a signing key pointer string for the KSK's active key.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-AsJob <SwitchParameter>

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

Aliases

Cn

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CryptoAlgorithm <String>

Specifies a cryptographic algorithm to use for key generation.

Aliases

None

Required?

false

Position

4

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DnsKeySignatureValidityPeriod <TimeSpan>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DSSignatureValidityPeriod <TimeSpan>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-InitialRolloverOffset <TimeSpan>

Specifies the amount of time to delay the first scheduled key rollover. You can use InitialRolloverOffset to stagger key rollovers.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-KeyLength <UInt32>

Specifies the bit length of a key.

Aliases

None

Required?

false

Position

5

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-KeyStorageProvider <String>

Specifies the Key Storage Provider that the DNS server uses to generate keys.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-NextKey <String>

Specifies a signing key pointer string for the next key. The DNS server uses this key during the next key rollover event.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

-RolloverPeriod <TimeSpan>

Specifies the amount of time between scheduled key rollovers.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-StandbyKey <String>

Specifies a signing key pointer string for the KSK's standby key.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-StoreKeysInAD <Boolean>

Stores the keys in Active Directory Domain Services (AD DS). This setting applies only to Active Directory-integrated zones when the vendor of KeyStorageProvider is Microsoft.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

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

-Type <String>

Specifies whether a key is a KSK or a ZSK.

Aliases

KeyType

Required?

false

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ZoneName <String>

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

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ZoneSignatureValidityPeriod <TimeSpan>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

Microsoft.Management.Infrastructure.CimInstance#DnsServerSigningKey

Notes

None

Examples

Example 1: Add a KSK to a DNS zone

This command adds a KSK to the DNS signed-zone corp.contoso.com.

PS C:\> Add-DnsServerSigningKey -ZoneName "corp.contoso.com" -Type "KeySigningKey" -CryptoAlgorithm "RsaSha1NSec3" –KeyLength 2048 -PassThru -Verbose

Online Version
Disable-DnsServerSigningKeyRollover
Enable-DnsServerSigningKeyRollover
Get-DnsServerSigningKey
Invoke-DnsServerSigningKeyRollover
Remove-DnsServerSigningKey
Set-DnsServerSigningKey