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
 

Remove-DnsServerResourceRecord

Remove-DnsServerResourceRecord

ps_dnsserverresourcerecord_v1.0.0.cdxml

Synopsis

Removes specified DNS server resource records from a zone.

Syntax

Remove-DnsServerResourceRecord [-ZoneName] [-AsJob] [-CimSession] [-ComputerName] [-Force] [-PassThru] [-ThrottleLimit] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Remove-DnsServerResourceRecord [-ZoneName] [-Name] [-RRType] [-AsJob] [-CimSession] [-ComputerName] [-Force] [-PassThru] [-RecordData] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Remove-DnsServerResourceRecord removes resource record objects from a DNS zone.

You can either use the Get-DnsServerResourceRecord cmdlet to specify an object, or you can specify the RRtype, Name and RecordData of the resource record you want to remove. If you specify an RRtype or name and there are multiple resource records, you can specify the RecordData to delete a specific record. If you do not specify RecordData, the cmdlet deletes all records that match RRtype and Name for the specified zone.

Parameters

-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 DNS server. If you do not specify this parameter, the command runs on the local system. 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,ForwardLookupPrimaryServer

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

Removes a record or records without prompting you for confirmation. By default, the cmdlet prompts you for confirmation before it proceeds.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <CimInstance>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-Name <String>

Specifies the name of a DNS server resource record object.

Aliases

RecordName

Required?

true

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

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

-RecordData <String[]>

Specifies the data contained in the resource record you want to delete.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RRType <String>

Specifies the type of resource record.

The acceptable values for this parameter are:  -- HInfo -- Afsdb -- Atma -- Isdn -- Key -- Mb -- Md -- Mf -- Mg -- MInfo -- Mr -- Mx -- NsNxt -- Rp -- Rt -- Wks -- X25 -- A -- AAAA -- CName -- Ptr -- Srv -- Txt -- Wins -- WinsR -- Ns -- Soa -- NasP -- NasPtr -- DName -- Gpos -- Loc -- DhcId -- Naptr -- RRSig -- DnsKey -- DS -- NSec -- NSec3 -- NSec3Param

Aliases

None

Required?

true

Position

4

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

-ZoneName <String>

Specifies the name of a DNS zone.

Aliases

ForwardLookupZone

Required?

true

Position

2

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

Microsoft.Management.Infrastructure.CimInstance# DnsServerResourceRecord[]

Return Type

Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord[]

Notes

None

Examples

Example 1: Remove all root hints

This command removes all root hints for a DNS server.

PS C:\>Get-DnsServerResourceRecord -ZoneName "..roothints" | Remove-DnsServerResourceRecord -Force -ZoneName "..roothints"

Example 2: Remove multiple A records

This command removes all A resource records in the contoso.com zone that have the name Host01.

PS C:\>Remove-DnsServerResourceRecord -ZoneName "contoso.com" -RRType "A" -Name "Host01"
Confirm

Removing DNS resource record Host01 of type A from zone contoso.com on ROOT server. Do you want to continue?

[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): n

Example 3: Remove an A record

This command removes the A resource record from a zone named contoso.com that has the name Host01 and the IP address 10.17.1.41.

PS C:\>Remove-DnsServerResourceRecord -ZoneName "contoso.com" -RRType "A" -Name "Host01" -RecordData "10.17.1.41" 

Online Version
Get-DnsServerResourceRecord
Set-DnsServerResourceRecord
Add-DnsServerResourceRecord