Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-DnsServer

Brian Lich|Last Updated: 3/28/2017

SYNOPSIS

Retrieves a DNS server configuration.

SYNTAX

Get-DnsServer [-ComputerName <String>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
 [<CommonParameters>]

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 pass the output of the Get-DnsServer cmdlet to the Export-Clixml cmdlet by using the pipeline operator. That cmdlet 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.

EXAMPLES

Example 1: Get a DNS server configuration

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

This command gets a DNS server configuration.

Example 2: Get local DNS server configuration and then export it

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

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

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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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[]
Parameter Sets: (All)
Aliases: Session

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

-ComputerName

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.

Type: String
Parameter Sets: (All)
Aliases: Cn

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases: 

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

Microsoft.Management.Infrastructure.CimInstance#DnsServer

NOTES

Set-DnsServer

Test-DnsServer

© 2017 Microsoft