NAME
Set-DnsClientNrptRule
SYNOPSIS
Modifies a DNS client Name Resolution Policy Table (NRPT) rule for the specified namespace.
SYNTAX
Set-DnsClientNrptRule [-Name] [-CimSession ] [-Comment ] [-DAEnable ]
[-DAIPsecEncryptionType { | None | Low | Medium | High}] [-DAIPsecRequired ] [-DANameServers ]
[-DAProxyServerName ] [-DAProxyType { | NoProxy | UseDefault | UseProxyName}] [-DisplayName ]
[-DnsSecEnable ] [-DnsSecIPsecEncryptionType { | None | Low | Medium | High}] [-DnsSecIPsecRequired
] [-DnsSecValidationRequired ] [-GpoName ] [-IPsecTrustAuthority ]
[-NameEncoding {Disable | Utf8WithMapping | Utf8WithoutMapping | Punycode}] [-NameServers ] [-Namespace
] [-PassThru] [-Server ] [-ThrottleLimit ] [-Confirm] [-WhatIf] []
DESCRIPTION
The Set-DnsClientNrptRule cmdlet modifies the specified DNS client Name Resolution Policy Table (NRPT) rule.
PARAMETERS
-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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Comment []
Stores administrator comments.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DAEnable []
Indicates the rule state for DirectAccess (DA).
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DAIPsecEncryptionType []
Specifies the IPsec encryption type for DA. The acceptable values for this parameter are:
-- None
-- Low
-- Medium
-- High
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DAIPsecRequired []
Indicates whether IPsec is required.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DANameServers []
Specifies the DNS servers which will be queried when DA is enabled.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DAProxyServerName []
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DAProxyType []
Specifies the proxy server type to be used when connecting to the Internet. The acceptable values for this
parameter are:
-- NoProxy
-- UseDefault
-- UseProxyName
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DisplayName []
Specifies an optional friendly name for the NRPT rule.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DnsSecEnable []
Indicates whether DNSSEC is enabled on the rule.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DnsSecIPsecEncryptionType []
Specifies the IPsec tunnel encryption settings. The acceptable values for this parameter are:
-- None
-- Low
-- Medium
-- High
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DnsSecIPsecRequired []
Indicates that the DNS client must set up an IPsec connection to the DNS server.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DnsSecValidationRequired []
Indicates that DNSSEC validation is required.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-GpoName []
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-IPsecTrustAuthority []
Specifies the Certification Authority (CA) to validate the IPsec channel for DA.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name
Specifies the name which uniquely identifies a rule.
Required? true
Position? 2
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NameEncoding []
Specifies the encoding format for host names in the DNS query. The acceptable values for this parameter are:
-- Disable
-- Utf8WithMapping
-- Utf8WithoutMapping
-- Punycode
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NameServers []
Specifies the DNS servers to which the DNS query is sent when DA is disabled.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Namespace []
Specifies the DNS namespace. The acceptable values for this parameter are:
-- Suffix
-- Prefix
-- FQDN
-- Subnet
-- Any
If this parameter is set to Any, then the parameter value must be specified in dot-notation.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Server []
Specifies the server hosting the GPO. This parameter is only applicable with the GpoName parameter.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
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 PowerShellr 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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Confirm []
Prompts you for confirmation before running the cmdlet.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.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
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
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
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.
Example 1: Modify an NRPT rule
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"
This example modifies an NRPT rule for a GPO named TestGPO on the server named host1.com for namespace dnsnrpt.com.
RELATED LINKS
Online Version:
Add-DnsClientNrptRule
Get-DnsClientNrptGlobal
Get-DnsClientNrptPolicy
Get-DnsClientNrptRule
Remove-DnsClientNrptRule
Set-DnsClientNrptGlobal