Edit

Share via

Get-IpamDnsConditionalForwarder

  • Reference
Module:
IpamServer

Gets information about DNS conditional forwarders from IPAM database.

Syntax

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

Description

The Get-IpamDnsConditionalForwarder cmdlet gets information about the Domain Name System (DNS) conditional forwarders found in the IP Address Management (IPAM) database. Conditional forwarders forward queries to a specific DNS server based on the DNS domain names used in those queries.

Examples

Example 1: Get information about all conditional forwarders

PS C:\> Get-IpamDnsConditionalForwarder

This command gets information about all the conditional forwarders in the IPAM database.

Example 2: Get information about a specific conditional forwarder

PS C:\> Get-IpamDnsConditionalForwarder -ConditionalForwarderName "contoso-internal.com"

This command gets information about the conditional forwarder named contoso-internal.com.

Example 3: Get information about all the conditional forwarders on a server

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

This command gets information about all the conditional forwarders found on the server named dns.contoso.com.

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

-ConditionalForwarderName

Specifies the name, as a string array, of the conditional forwarderthat this cmdlet gets. For example:

-ConditionalForwarderName "contoso-test.com"

``

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ServerFqdn

Specifies the fully qualified domain name (FQDN) of the DNS server hosting the conditional forwarder that this cmdlet gets. For example:

-ServerFqdn "dns.contoso.com"

Type:String[]
Position:2
Default value:None
Required:False
Accept pipeline input:True
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

Outputs

This cmdlet returns an object that represents an instance of the IpamDnsConditionalForwarder object.