Set-DnsClientNrptRule

Set-DnsClientNrptRule

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

Syntax

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

Detailed Description

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

Parameters

-AsJob

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	none
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	none
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	none
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	none
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	none
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	none
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	none
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	none
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	none
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	none
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	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?	1
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

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?	true (ByPropertyName)
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

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

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

  The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Outputs

The output type is the type of the objects that the cmdlet emits.

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

  The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
  The DnsClientNrptRule object contains all of the properties of the DNS client NRPT rule.

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

Related topics

Add-DnsClientNrptRule

Get-DnsClientNrptGlobal

Get-DnsClientNrptPolicy

Get-DnsClientNrptRule

Remove-DnsClientNrptRule

Set-DnsClientNrptGlobal