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
 

Set-DnsClientNrptRule

Set-DnsClientNrptRule

ps_dnsclientnrptrule_v1.0.0.cdxml

Synopsis

Modifies a DNS client Name Resolution Policy Table (NRPT) rule for the specified namespace.

Syntax

Set-DnsClientNrptRule [-Name] [-AsJob] [-CimSession] [-Comment] [-DAEnable] [-DAIPsecEncryptionType] [-DAIPsecRequired] [-DANameServers] [-DAProxyServerName] [-DAProxyType] [-DisplayName] [-DnsSecEnable] [-DnsSecIPsecEncryptionType] [-DnsSecIPsecRequired] [-DnsSecValidationRequired] [-GpoName] [-IPsecTrustAuthority] [-NameEncoding] [-NameServers] [-Namespace] [-PassThru] [-Server] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-DnsClientNrptRule cmdlet modifies 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

-Comment <String>

Stores administrator comments.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DAEnable <Boolean>

Specifies the rule state for DirectAccess (DA).

Aliases

DirectAccessEnabled

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DAIPsecEncryptionType <String>

Specifies the IPsec encryption type for DA. The acceptable values for this parameter are:  None, Low, Medium, or High.

Aliases

DirectAccessQueryIPSSECEncryption

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DAIPsecRequired <Boolean>

Specifies the IPsec tunnel encryption settings.

Aliases

DirectAccessQueryIPsecRequired

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DANameServers <String[]>

Specifies the DNS servers which will be queried when DA is enabled.

Aliases

DirectAccessDNSServers

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DAProxyServerName <String>

Specifies the proxy server to be used when connecting to the Internet. This parameter is only applicable when the DAProxyType parameter is set to UseProxyName.

Aliases

DirectAccessProxyName

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DAProxyType <String>

Specifies the proxy server type to be used when connecting to the Internet. The acceptable values for this parameter are:  NoProxy, UseDefault, or UseProxyName.

Aliases

DirectAccessProxyType

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DisplayName <String>

Specifies an optional friendly name for the NRPT rule.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DnsSecEnable <Boolean>

Specifies that DNSSEC is enabled on the rule.

Aliases

DnsSecEnabled

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DnsSecIPsecEncryptionType <String>

Specifies the IPsec tunnel encryption settings. The acceptable values for this parameter are:  None, Low, Medium, or High.

Aliases

DnsSecQueryIPsecEncryption

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DnsSecIPsecRequired <Boolean>

Specifies that the DNS client must set up an IPsec connection to the DNS server.

Aliases

DnsSecQueryIPsecRequired

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DnsSecValidationRequired <Boolean>

Specifies that DNSSEC validation is required.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

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

-IPsecTrustAuthority <String>

Specifies the Certification Authority (CA) to validate the IPsec channel for DA.

Aliases

IPsecCARestriction

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

-NameEncoding <String>

Specifies the encoding format for host names in the DNS query. The acceptable values for this parameter are:  Disable, Utf8WithMapping, Utf8WithoutMapping, or Punycode.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-NameServers <String[]>

Specifies the DNS servers to which the DNS query is sent when DA is disabled.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Namespace <String[]>

Specifies the DNS namespace. The acceptable values for this parameter are:  Suffix, Prefix, FQDN, Subnet, or Any. If this parameter is set to Any, then the parameter value must be specified in dot-notation.

Aliases

None

Required?

false

Position

named

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 server hosting 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 modifies an NRPT rule for GPO named TestGPO on the server named host1.com for namespace dnsnrpt.com.

PS C:\>Set-DnsClientNrptRule  -DAEnable $true -DAIPsecEncryptionType "High" -DAIPsecRequired $true -DANameServers 10.0.0.1 -DAProxyServerName "DaServer.com:6666" -DAProxyType "UseProxyName" -DisplayName "Sample" -PassThru -IPsecTrustAuthority "RootCA" -Name "{1326d9d0-4fb5-4fed-9f67-f53637b85010}" -NameEncoding "Punycode" -NameServers 10.0.0.1 -Namespace "dnsnrpt.com" -Server host1.com -Comment "Sample NRPT Rule" -DnsSecEnable $true -DnsSecIPsecEncryptionType "Medium" -DnsSecIPsecRequired $true -DnsSecValidationRequired $true -GpoName TestGPO

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