Skip to content

Latest commit

 

History

History
228 lines (177 loc) · 6.19 KB

Remove-DnsServerClientSubnet.md

File metadata and controls

228 lines (177 loc) · 6.19 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_DnsServerClientSubnet_v1.0.0.cdxml-help.xml
DnsServer
12/20/2016
2.0.0
Remove-DnsServerClientSubnet

Remove-DnsServerClientSubnet

SYNOPSIS

Removes a client subnet from a DNS server.

SYNTAX

Remove-DnsServerClientSubnet [-Name] <String> [-PassThru] [-Force] [-ComputerName <String>]
 [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Remove-DnsServerClientSubnet cmdlet removes a client subnet from a Domain Name System (DNS) server. If a client subnet appears in any DNS policy, you cannot remove that subnet.

EXAMPLES

Example 1: Remove a client subnet

PS C:\> Remove-DnsServerClientSubnet -Name AsiaSubnet -PassThru -Force | Format-List
Name       : AsiaSubnet
IPV4Subnet : {192.168.0.4/16}
IPV6Subnet : {0db8::1/8}

This command removes the client subnet named AsiaSubnet from the DNS server. The command specifies the Force parameter, so it does not prompt you for confirmation. The command uses the Format-List cmdlet to control the appearance of the output. For more information, type Get-Help Format-List.

Example 2: Remove all client subnets by using the pipeline

PS C:\> Get-DnsServerClientSubnet | Remove-DnsServerClientSubnet -PassThru -Force | Format-List
Name       : EuropeSubnet
IPV4Subnet : 
IPV6Subnet : {0db8::1/28}

Name       : NorthAmericaSubnet
IPV4Subnet : {172.21.0.0/16}
IPV6Subnet :

This command gets all the client subnets by using the Get-DnsServerClientSubnet cmdlet. The command passes them to the current cmdlet by using the pipeline operator. The current cmdlet removes each client subnet. The command specifies the Force parameter, so it does not prompt you for confirmation.

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

Forces the command to run without asking for user confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-Name

Specifies the name of the client subnet to remove.

Type: String
Parameter Sets: (All)
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#DnsServerClientSubnet

NOTES

RELATED LINKS

Add-DnsServerClientSubnet

Get-DnsServerClientSubnet

Set-DnsServerClientSubnet