Get-IpamDnsConditionalForwarder
Gets information about DNS conditional forwarders from IPAM database.
Syntax
Default (Default)
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ConditionalForwarderName
Specifies the name, as a string array, of the conditional forwarderthat this cmdlet gets. For example:
-ConditionalForwarderName "contoso-test.com"
``
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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"
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs
IpamDnsConditionalForwarder
This cmdlet returns an object that represents an instance of the IpamDnsConditionalForwarder object.