Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-IpamDiscoveryDomain

Add-IpamDiscoveryDomain

ipamdiscoverydomain.cdxml

Synopsis

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

Syntax

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

Detailed 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.

Parameters

-AsJob <SwitchParameter>

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.

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

-DiscoverDc <Boolean>

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

Aliases

None

Required?

false

Position

named

Default value

true

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DiscoverDhcp <Boolean>

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

Aliases

None

Required?

false

Position

named

Default value

true

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DiscoverDns <Boolean>

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

Aliases

None

Required?

false

Position

named

Default value

true

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

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.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

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

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

IpamDiscoveryDomain

Notes

None

Examples

Example 1: Add domains to the IPAM discovery domain

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

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

DomainName            DiscoverDc    DiscoverDhcp    DiscoverDns

child1.contoso.com    false         true            true

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

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

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

child1.contoso.com    true          true            true

Online Version
Get-IpamDiscoveryDomain
Remove-IpamDiscoveryDomain
Set-IpamDiscoveryDomain