Get-IpamDiscoveryDomain
Get-IpamDiscoveryDomain
Gets the list of Active Directory domains in which IPAM discovers infrastructure servers.
Syntax
Parameter Set: ByName
Get-IpamDiscoveryDomain [[-Name] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed 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.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<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.
Aliases |
Session |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies an array of FQDNs in an Active Directory domain to retrieve.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
IpamDiscoveryDomain
Represents an Active Directory domain in which IPAM discovers infrastructure servers.
Examples
Example 1: Get all discovery domains
This command gets all discovery domains that are configured in IPAM.
PS C:\> Get-IpamDiscoveryDomain
Example 2: Get a specific discovery domain
This command gets a discovery domain named Contoso.com, which is configured in IPAM.
PS C:\> Get-IpamDiscoveryDomain -Name Contoso.com