Export (0) Print
Expand All

Add-DnsClientNrptRule

Updated: August 12, 2013

Applies To: Windows Server 2012

Add-DnsClientNrptRule

Adds a rule to the Name Resolution Policy Table (NRPT).

Syntax

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




Detailed Description

The Add-DnsClientNrptRule cmdlet adds a Name Resolution Policy Table (NRPT) rule for the specified namespace.

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.


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 notes.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-DAEnable

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

Specifies that IPsec is required for DA.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-DANameServers<String[]>

Specifies the DNS servers that 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 the DAProxyType parameter is set to UseProxyName.
The allowed formats for this parameter are: hostname:port, IPv4 address:port, or IPv6 address:port.


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

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

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-DnsSecIPsecRequired

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

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 to validate the IPsec channel.


Aliases

none

Required?

false

Position?

named

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.


Aliases

none

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.


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

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.

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 adds an NRPT rule in TestGPO on server host1.com for the namespace dnsnrpt.com.


PS C:\> Add-DnsClientNrptRule -GpoName TestGPO -DANameServers 10.0.0.1 -DAIPsecRequired -DAIPsecEncryptionType "High" -DAProxyServerName "DaServer.com:6666" -DnsSecEnable -PassThru -DAProxyType "UseProxyName" -DnsSecValidationRequired -DAEnable -IPsecTrustAuthority "RootCA" -Comment "Sample NRPT Rule" -DisplayName "Sample" -DnsSecIPsecRequired -DnsSecIPsecEncryptionType "Medium" -NameServers 10.0.0.1 -NameEncoding "Punycode" -Namespace "dnsnrpt.com" -Server host1.com

EXAMPLE 2

This example adds an NRPT rule that configures the server named 10.0.0.1 as a DNS server for the namespace pqr.com.


PS C:\> Add-DnsClientNrptRule -Namespace pqr.com -NameServers 10.0.0.1

EXAMPLE 3

This example adds an NRPT rule that enables DNSSEC queries to be sent for the namespace pqr.com.


PS C:\> Add-DnsClientNrptRule -Namespace pqr.com -DnsSecEnable

EXAMPLE 4

This example adds an NRPT rule that enables DNSSEC queries to be sent to DNS server named 10.0.0.1 for the namespace pqr.com.


PS C:\> Add-DnsClientNrptRule -Namespace pqr.com -DnsSecEnable -NameServers 10.0.0.1

EXAMPLE 5

This example adds an NRPT rule that sends DNS queries encoded in Punycode to DNS server named 10.1.1.1 for the namespace pqr.com.


PS C:\> Add-DnsClientNrptRule -Namespace pqr.com -NameEncoding Punycode -NameServers 10.1.1.1 -PassThru
Name                             : {6a78d8d1-231d-4d1e-bc23-fb593e11a53d} 
Version                          : 2 
Namespace                        : {pqr.com} 
IPsecCARestriction               : 
DirectAccessDnsServers           : 
DirectAccessEnabled              : False 
DirectAccessProxyType            : 
DirectAccessProxyName            : 
DirectAccessQueryIPsecEncryption : 
DirectAccessQueryIPsecRequired   : 
NameServers                      : 10.1.1.1 
DnsSecEnabled                    : False 
DnsSecQueryIPsecEncryption       : 
DnsSecQueryIPsecRequired         : 
DnsSecValidationRequired         : 
NameEncoding                     : Punycode 
DisplayName                      : 
Comment                          : 

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft