Get-IpamDnsServer

Gets information about DNS servers from IPAM database.

Syntax

Get-IpamDnsServer
   [[-ServerFqdn] <String[]>]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [<CommonParameters>]

Description

The Get-IpamDnsServer cmdlet returns information about the Domain Name System (DNS) servers found in the IPAM (IP Address Management) server database.

Examples

Example 1: Get information about all DNS servers

PS C:\> Get-IpamDnsServer

This command returns information about all the IPAM DNS servers.

Example 2: Get information about a specific DNS server

PS C:\> Get-IpamDnsServer -ServerFqdn "dns.contoso.com"

This command returns information for a single IPAM DNS server named dns.contoso.com.

Optional 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
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
Accept pipeline input:False
Accept wildcard characters:False
-ServerFqdn

Specifies the fully qualified domain name of the DNS server to be retrieved. For example:

-ServerFqdn "dns.contoso.com"

Type:String[]
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:False
Accept wildcard characters:False

Outputs

This cmdlet returns an instance of the IpamDnsServer object.