Get-DnsClient

Get-DnsClient

Retrieves details of the network interfaces configured on a specified computer.

Syntax

Parameter Set: ByName
Get-DnsClient [[-InterfaceAlias] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ConnectionSpecificSuffix <String[]> ] [-InterfaceIndex <UInt32[]> ] [-RegisterThisConnectionsAddress <Boolean[]> ] [-ThrottleLimit <Int32> ] [-UseSuffixWhenRegistering <Boolean[]> ] [ <CommonParameters>]

Detailed Description

The Get-DnsClient cmdlet retrieves configuration details specific to the different network interfaces on a specified computer.

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

-ConnectionSpecificSuffix<String[]>

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.

Aliases	Suffix
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-InterfaceAlias<String[]>

Specifies the friendly name of the interface.

Aliases	none
Required?	false
Position?	1
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-InterfaceIndex<UInt32[]>

Specifies the index number of the interface.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByValue, ByPropertyName)
Accept Wildcard Characters?	false

-RegisterThisConnectionsAddress<Boolean[]>

Specifies the registration policy for this interface.
This parameter specifies that the computer should automatically register the IP address associated with this connection with the DNS server.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
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

-UseSuffixWhenRegistering<Boolean[]>

Specifies the registration suffix policy for this interface.
This parameter specifies that suffixes need to be used while registering an IP address.

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\StandardCimv2\MSFT_DNSClient

  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.

• Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClientServerAddress

  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.

• Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetAdapter

  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.

• Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIPInterface

  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\StandardCimv2\MSFT_DNSClient

  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.

Examples

EXAMPLE 1

This example gets configuration details of network interfaces on a computer.

PS C:\> Get-DnsClient

EXAMPLE 2

This example sets the DNS server IP address on all of the wired Ethernet connections on a computer.

PS C:\> $dnsClient1 = Get-DnsClient -InterfaceAlias "Wired Ethernet Connection"

PS C:\> Set-DnsClientServerAddress –InputObject $dnsClinet1 -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")

EXAMPLE 3

This example resets all of the network interfaces to use DHCP-specified DNS server addresses.

PS C:\> Get-DnsClient | Set-DnsClientServerAddress -ResetServerAddresses

Related topics

Register-DnsClient

Set-DnsClient