Get-Ipam Discovery Domain

Module:
ipamserver
Gets the list of Active Directory domains in which IPAM discovers infrastructure servers.

Syntax 

Get-IpamDiscoveryDomain
   [[-Name] <String[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-IpamDiscoveryDomain cmdlet gets the list of Active Directory domains in which IP Address Management (IPAM) discovers infrastructure servers. You can retrieve the configuration for a particular domain by specifying the fully qualified domain name (FQDN) of that domain.

Examples

Example 1: Get all discovery domains 

PS C:\> Get-IpamDiscoveryDomain
DomainName                    DiscoverDc                    DiscoverDns                   DiscoverDhcp

----------                    ----------                    -----------                   ------------

contoso.com                   True                          True                          True

minings.com                   False                         True                          True

This command gets all discovery domains that are configured in IPAM.

Example 2: Get a specific discovery domain 

PS C:\> Get-IpamDiscoveryDomain -Name "Contoso.com"
DomainName                    DiscoverDc                    DiscoverDns                   DiscoverDhcp

----------                    ----------                    -----------                   ------------

contoso.com                   True                          True                          True

This command gets a discovery domain named Contoso.com, which is configured in IPAM.

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

Specifies an array of FQDNs in an Active Directory domain to retrieve.

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

IpamDiscoveryDomain

This cmdlet returns an object that represents an Active Directory domain in which IPAM discovers infrastructure servers.