Skip to content

Latest commit

 

History

History
260 lines (201 loc) · 7.22 KB

Remove-DnsServerRootHint.md

File metadata and controls

260 lines (201 loc) · 7.22 KB
description external help file Module Name ms.date online version schema title
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
PS_DnsServerRootHint_v1.0.0.cdxml-help.xml
DnsServer
12/20/2016
2.0.0
Remove-DnsServerRootHint

Remove-DnsServerRootHint

SYNOPSIS

Removes root hints from a DNS server.

SYNTAX

InputObject (Default)

Remove-DnsServerRootHint [-ComputerName <String>] [-PassThru] [-Force] [-InputObject] <CimInstance>
 [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]

Parameters

Remove-DnsServerRootHint [-ComputerName <String>] [-PassThru] [-Force] [[-IPAddress] <IPAddress[]>]
 [-NameServer] <String> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

The Remove-DnsServerRootHint cmdlet removes root hints from the list of root hints on a Domain Name System (DNS) server. When you remove a root hint from a DNS server, the DNS server cannot contact the root DNS server on startup and cannot answer queries for names outside its own authoritative zones.

EXAMPLES

Example 1: Remove all root hints on a DNS server

PS C:\> Get-DnsServerRootHint | Remove-DnsServerRootHint

This command removes all root hints on the local DNS server. The Get-DnsServerRootHint cmdlet gets all root hints on the local DNS server and passes the results to the Remove-DnsServerRootHint cmdlet.

Example 2: Remove a root hint by using a resource record

PS C:\> Get-DnsServerRootHint | Where-Object {$_.NameServer.RecordData.NameServer -eq "H.Root-Servers.net."} | Remove-DnsServerRootHint

In this example, the Get-DnsServerRootHint cmdlet gets a list of all root hints on the local DNS server. The command then passes that collection to the Where-Object cmdlet.

Where-Object filters out the resource record to get the root hint for the DNS name server that is named H.Root-Servers.net. Where-Object then passes the filtered DnsServerRootHint object to the Remove-DnsServerRootHint cmdlet, which removes the root hint.

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

-Force

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-IPAddress

Specifies an array of IPv4 or IPv6 addresses of DNS servers to remove. If you do not specify IPAddress, this cmdlet removes all root hints on the specified DNS server.

Type: IPAddress[]
Parameter Sets: Parameters
Aliases: 

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

-InputObject

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

Type: CimInstance
Parameter Sets: InputObject
Aliases: 

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

-NameServer

Specifies the name of a root hint to remove.

Type: String
Parameter Sets: Parameters
Aliases: 

Required: True
Position: 1
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

-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

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#DnsServerRootHint

NOTES

RELATED LINKS

Get-DnsServerRootHint

Add-DnsServerRootHint

Set-DnsServerRootHint

Import-DnsServerRootHint