Get-DnsServer

Get-DnsServer

Retrieves a DNS server configuration.

Syntax

Parameter Set: Get0
Get-DnsServer [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-DnsServer cmdlet retrieves a Domain Name System (DNS) server configuration. The DNS server must be running Windows Server® 2008 R2 operating system or above.

You can pipe the output of the Get-DnsServer cmdlet to the Export-Clixml cmdlet, which generates an XML file of the configuration. You can use the XML file to back up or transfer DNS settings between computers. For more information about Export-Clixml, see Using the Export-Clixml Cmdlet.

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

-ComputerName<String>

Specifies a DNS server. The acceptable values for this parameter are: an IP V4 address; an IP V6 address; any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name.

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

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

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimInstance#DnsServer

Examples

Example 1: Get a DNS server configuration

This command gets a DNS server configuration.

PS C:\> Get-DnsServer -ComputerName "10.255.255.254"

Example 2: Get local DNS server configuration and pipe it to Export-Clixml

This command gets the DNS server configuration on the local server and pipes it to the Export-Clixml cmdlet to be translated into an XML file.

PS C:\> Get-DnsServer | Export-Clixml -Path "c:\config\DnsServerConfig.xml"

Set-DnsServer

Test-DnsServer