Modifier

Remove-DnsServerSigningKey

  • Reference
Module:
DnsServer

Removes signing keys.

Syntax

Remove-DnsServerSigningKey
      [-ZoneName] <String>
      [-PassThru]
      [-KeyId] <Guid[]>
      [-Force]
      [-ComputerName <String>]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-DnsServerSigningKey cmdlet removes one or more signing keys from the specified Domain Name System (DNS) zone. This cmdlet removes signing keys on an unsigned zone that you incorrectly configured. This cmdlet cannot remove active signing keys from a signed zone.

Examples

Example 1: Remove signing keys for a zone

PS C:\> Get-DnsServerSigningKey -ZoneName "west.contoso.com" | Remove-DnsServerSigningKey

This first part of the command gets the DNS server signing keys for the west.contoso.com zone and passes the results to the Remove-DnsServerSigningKey cmdlet by using the pipeline operator. The second part of the command removes DNS server signing keys.

Example 2: Remove a single signing key for a zone

PS C:\> Remove-DnsServerSigningKey -ZoneName contoso.com -KeyId "6ff2c4b3-3eeb-4074-908f-bca0cca153c7"

This command removes the signing key that has the ID 6ff2c4b3-3eeb-4074-908f-bca0cca153c7 from the zone named contoso.com.

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
Required:False
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
Required:False
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
Aliases:Cn
Position:Named
Default value:None
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Removes the signing keys without prompting you for confirmation. By default, the cmdlet prompts you for confirmation before it proceeds.

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

-KeyId

Specifies an array of key identifiers.

Type:Guid[]
Position:2
Default value:None
Required:True
Accept pipeline input:True
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
Required:False
Accept pipeline input:False
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
Required:False
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
Required: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
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Outputs

CimInstance[]