Edit

Share via

Get-DnsClientNrptRule

  • Reference
Module:
DnsClient

Retrieves the DNS client NRPT rules.

Syntax

Get-DnsClientNrptRule
   [-GpoName <String>]
   [[-Name] <String[]>]
   [-Server <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-DnsClientNrptRule cmdlet retrieves DNS client Name Resolution Policy Table (NRPT) rules with the following details:

  • DNS client name setting.
  • DNS client version setting.
  • DNS client namespace setting.
  • DNS client IPsec Certification Authority (CA) restriction setting.
  • Direct Access (DA) DNS servers setting.
  • DA enabled setting.
  • DA proxy type setting.
  • DA proxy name setting.
  • DA query IPsec encryption setting.
  • DA query IPsec required setting.
  • DNS client name servers setting.
  • DNS security enabled setting.
  • DNS security query IPsec encryption setting.
  • DNS security query IPsec required setting.
  • DNS security validation required setting.
  • DNS client name encoding setting.
  • DNS client display name setting.
  • DNS client comment setting.

Examples

Example 1: Get NRPT rules for a specified GPO

PS C:\> Get-DnsClientNrptRule -GpoName "corp.contoso.com\DirectAccess Client Settings"

Name                             : DA-{FD4B6054-F8C8-4868-94E6-8132AC707DBD}
Version                          : 1
Namespace                        : {.corp.contoso.com}
IPsecCARestriction               :
DirectAccessDnsServers           : {2001:db8:1::2, 2001:db8:2::20, 2001:db8:6::6}
DirectAccessEnabled              : True
DirectAccessProxyType            : NoProxy
DirectAccessProxyName            :
DirectAccessQueryIPsecEncryption :
DirectAccessQueryIPsecRequired   : False
NameServers                      :
DnsSecEnabled                    : False
DnsSecQueryIPsecEncryption       :
DnsSecQueryIPsecRequired         :
DnsSecValidationRequired         :
NameEncoding                     : Disable
DisplayName                      :
Comment                          :

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 example retrieves NRPT rules for the specified GPO.

Example 2: Get the NRPT rules on a specified server

PS C:\> Get-DnsClientNrptRule -GpoName "corp.contoso.com\DirectAccess Client Settings" -Server "dc1"

Name                             : DA-{FD4B6054-F8C8-4868-94E6-8132AC707DBD}
Version                          : 1
Namespace                        : {.corp.contoso.com}
IPsecCARestriction               :
DirectAccessDnsServers           : {2001:db8:1::2, 2001:db8:2::20, 2001:db8:6::6}
DirectAccessEnabled              : True
DirectAccessProxyType            : NoProxy
DirectAccessProxyName            :
DirectAccessQueryIPsecEncryption :
DirectAccessQueryIPsecRequired   : False
NameServers                      :
DnsSecEnabled                    : False
DnsSecQueryIPsecEncryption       :
DnsSecQueryIPsecRequired         :
DnsSecValidationRequired         :
NameEncoding                     : Disable
DisplayName                      :
Comment                          :

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 example retrieves an NRPT rule for the specified GPO on the specified server.

Example 3: Get the NRPT rules on a remote computer

PS C:\> Get-DnsClientNrptRule -GpoName "corp.contoso.com\DirectAccess Client Settings" -CimSession 2-dc1.corp2.corp.contoso.com

This example retrieves the NRPT rules on the remote computer named 2-dc1.corp2.corp.contoso.com.

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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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.
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name which uniquely identifies a rule. If this parameter is not specified, then all of the available NRPT rules are retrieved.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Server

Specifies the server hosting the GPO. This parameter is only applicable with the GpoName parameter.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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 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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

CimInstance[]

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

CimInstance[]

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.