Get-DnsClientNrptRule
Get-DnsClientNrptRule
Retrieves the DNS client Name Resolution Policy Table (NRPT) rules.
Syntax
Parameter Set: Get1
Get-DnsClientNrptRule [[-Name] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-GpoName <String> ] [-Server <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed 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.
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 |
-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 |
-Name<String[]>
Specifies the name which uniquely identifies a rule. If this parameter is not specified, then all of the available NRPT rules are retrieved.
Aliases |
none |
Required? |
false |
Position? |
1 |
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 |
<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.CimInstanceobject 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.CimInstanceobject 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 retrieves an NRPT rules for the specified GPO.
PS C:\> Get-DnsClientNrptRule -GpoName "corp.contoso.com\DirectAccess Client Settings"
EXAMPLE 2
This example retrieves an NRPT rule for the specified GPO on the specified server.
PS C:\> Get-DnsClientNrptRule -GpoName "corp.contoso.com\DirectAccess Client Settings" -Server dc1
EXAMPLE 3
This example retrieves the NRPT rules on the remote computer named 2-dc1.corp2.corp.contoso.com.
PS C:\> Get-DnsClientNrptRule -GpoName "corp.contoso.com\DirectAccess Client Settings" -CimSession 2-dc1.corp2.corp.contoso.com