Get-DnsClient
Gets details of the network interfaces configured on a specified computer.
Syntax
Get-DnsClient
[-InterfaceIndex <UInt32[]>]
[[-InterfaceAlias] <String[]>]
[-ConnectionSpecificSuffix <String[]>]
[-RegisterThisConnectionsAddress <Boolean[]>]
[-UseSuffixWhenRegistering <Boolean[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Description
The Get-DnsClient cmdlet gets configuration details specific to the different network interfaces on a specified computer.
Examples
Example 1: Get the network interface configuration
PS C:\> Get-DnsClientThis command gets configuration details of network interfaces on a computer.
Example 2: Set the DNS server IP addresses for a computer
PS C:\> $dnsClient1 = Get-DnsClient -InterfaceAlias "Wired Ethernet Connection"
PS C:\> Set-DnsClientServerAddress -InputObject $dnsClient1 -ServerAddresses ("10.0.0.1","10.0.0.2")
This is a version of the cmdlet using the pipeline.
PS C:\> Get-DnsClient | Set-DnsClientServerAddress -ServerAddresses ("10.0.0.1","10.0.0.2")This command sets the DNS server IP addresses for all wired Ethernet connections on a computer.
Example 3: Reset the DNS client to use the default DNS server addresses specified by DHCP
PS C:\> Get-DnsClient | Set-DnsClientServerAddress -ResetServerAddressesThis command resets all network interfaces to use DHCP-specified DNS server addresses.
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 |
-ConnectionSpecificSuffix
Specifies the connection-specific suffixes that are to be appended. This parameter is a per-connection DNS suffix which will be appended to the computer name to construct a Fully Qualified Domain Name (FQDN). This FQDN will be used as the host name for name resolution by the DNS client.
| Type: | String[] |
| Aliases: | Suffix |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InterfaceAlias
Specifies the friendly name of the interface.
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InterfaceIndex
Specifies the index number of the interface.
| Type: | UInt32[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-RegisterThisConnectionsAddress
Specifies the registration policy for this interface.
This parameter indicates whether the computer should automatically register the IP address associated with this connection with the DNS server.
| Type: | Boolean[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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 |
-UseSuffixWhenRegistering
Specifies the registration suffix policy for this interface.
This parameter indicates whether suffixes must be used while registering an IP address.
| Type: | Boolean[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
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 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 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 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 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.