Edit

Add-IpamDiscoveryDomain

  • Reference
Module:
IpamServer

Adds a new Active Directory domain to the list of domains in which IPAM discovers infrastructure servers.

Syntax

Add-IpamDiscoveryDomain
   [-Name] <String>
   [-DiscoverDc <Boolean>]
   [-DiscoverDns <Boolean>]
   [-DiscoverDhcp <Boolean>]
   [-PassThru]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Add-IpamDiscoveryDomain cmdlet adds an Active Directory discovery domain for an IP Address Management (IPAM) server. A discovery domain is a domain that IPAM searches to find infrastructure servers. An IPAM server uses the list of discovery domains to determine what type of servers to add. By default, IPAM discovers all domain controllers, Dynamic Host Configuration Protocol (DHCP) servers, and Domain Name System (DNS) servers. You can specify the type of servers discovered per domain while you are adding the domain, or you can edit the same by using the Set-IpamDiscoveryDomain cmdlet.

Examples

Example 1: Add domains to the IPAM discovery domain

PS C:\> Add-IpamDiscoveryDomain -Name "child01.contoso.com" -DiscoverDc $False -PassThru
DomainName            DiscoverDc    DiscoverDhcp    DiscoverDns

child1.contoso.com    false         true            true

This command configures IPAM to discover DHCP and DNS servers in the domain named child01.contoso.com. Because the default values of the DiscoverDhcp, DiscoverDns, and DiscoverDc parameters are True, the command sets the DiscoverDc parameter to False to direct IPAM not to discover domain controllers in the domain.

The command includes the PassThru parameter, so it displays results to the console.

Example 2: Add domain controllers, DHCP, and DNS servers to a discovery domain

PS C:\> Add-IpamDiscoveryDomain -Name "child01.contoso.com" -PassThru
DomainName            DiscoverDc    DiscoverDhcp    DiscoverDns

child1.contoso.com    true          true            true

This command configures IPAM to discover domain controllers, DHCP servers, and DNS servers in the child01.contoso.com domain.

The command includes the PassThru parameter, so it displays results to the console.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DiscoverDc

Indicates whether IPAM discovers all domain controllers in a specified domain. By default, the value is True.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DiscoverDhcp

Indicates whether IPAM discovers all DHCP servers in a specified domain. By default, the value is True.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DiscoverDns

Indicates whether IPAM discovers all DNS servers in a specified domain. By default, the value is True.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the fully qualified domain name (FQDN) of the Active Directory domain that will be added to the list of domains in which IPAM will discover infrastructure servers.

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

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

IpamDiscoveryDomain

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