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

Remove-DnsClientNrptRule

ps_dnsclientnrptrule_v1.0.0.cdxml

Synopsis

Removes the specified DNS client Name Resolution Policy Table (NRPT) rule.

Syntax

Remove-DnsClientNrptRule [-Name] [-AsJob] [-CimSession] [-Force] [-GpoName] [-PassThru] [-Server] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Remove-DnsClientNrptRule cmdlet removes the specified DNS client Name Resolution Policy Table (NRPT) rule.

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

-Force <SwitchParameter>

Forces the command to run without asking for user confirmation.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-GpoName <String>

Specifies the name of the Group Policy Object (GPO). -- If this parameter and the Server parameter are specified, then the NRPT rule is added in the GPO of domain. The Server parameter specifies the domain controller (DC). -- If neither this parameter nor the Server parameter is specified, then the NRPT rule is added for local client computer. -- If this parameter is specified and the Server parameter is not specified, then the DC of the domain specified by this parameter value is found and NRPT rule is added to the GPO. -- If this parameter is not specified and the Server parameter is specified, then an error is displayed.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Specifies the name which uniquely identifies a rule.

Aliases

None

Required?

true

Position

2

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

-Server <String>

Specifies the name of the server containing the GPO. This parameter is only applicable with the GpoName parameter.

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

-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#root/Microsoft/Windows/DNS/DnsClientNrptRule

Return Type

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DNS/DnsClientNrptRule

Notes

None

Examples

EXAMPLE 1

This example removes the NRPT rule named {1326d9d0-4fb5-4fed-9f67-f53637b85010} on the server named host1.com.

PS C:\>Remove-DnsClientNrptRule -GpoName TestGPO -Name "{1326d9d0-4fb5-4fed-9f67-f53637b85010}" -PassThru -Server host1.com -Force

EXAMPLE 2

This example removes the NRPT rule named {1326d9d0-4fb5-4fed-9f67-f53637b85010}.

PS C:\>Remove-DnsClientNrptRule -Name "DA-{274D94E4-E38B-4997-BA9F-84700712C09E}" -PassThru
Confirm 
Removing NRPT rule for the namespace nls.corp.contoso.com with 
 DAEnable: Enable,
 DnsSecValidationRequired: Disabled, 
 NameEncoding: Disable 
 NameServers: No 
 Do you want to continue? 
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): Y 
 
Name                             : DA-{274D94E4-E38B-4997-BA9F-84700712C09E} 
Version                          : 1 
Namespace                        : {nls.corp.contoso.com} 
IPsecCARestriction               : 
DirectAccessDnsServers           : 
DirectAccessEnabled              : True 
DirectAccessProxyType            : UseDefault 
DirectAccessProxyName            : 
DirectAccessQueryIPsecEncryption : 
DirectAccessQueryIPsecRequired   : False 
NameServers                      : 
DnsSecEnabled                    : False 
DnsSecQueryIPsecEncryption       : 
DnsSecQueryIPsecRequired         : 
DnsSecValidationRequired         : 
NameEncoding                     : Disable 
DisplayName                      : 
Comment                          : 

This version of the cmdlet performs the task without user confirmation.
PS C:\>Remove-DnsClientNrptRule -Name "DA-{274D94E4-E38B-4997-BA9F-84700712C09E}" –PassThru -Force
Name                             : DA-{274D94E4-E38B-4997-BA9F-84700712C09E} 
Version                          : 1 
Namespace                        : {nls.corp.contoso.com} 
IPsecCARestriction               : 
DirectAccessDnsServers           : 
DirectAccessEnabled              : True 
DirectAccessProxyType            : UseDefault 
DirectAccessProxyName            : 
DirectAccessQueryIPsecEncryption : 
DirectAccessQueryIPsecRequired   : False 
NameServers                      : 
DnsSecEnabled                    : False 
DnsSecQueryIPsecEncryption       : 
DnsSecQueryIPsecRequired         : 
DnsSecValidationRequired         : 
NameEncoding                     : Disable 
DisplayName                      : 
Comment                          : 

Online Version
Add-DnsClientNrptRule
Get-DnsClientNrptGlobal
Get-DnsClientNrptPolicy
Get-DnsClientNrptRule
Set-DnsClientNrptGlobal
Set-DnsClientNrptRule