Add-IpamDiscoveryDomain

Windows Server Technical Preview and Windows 10

Add-IpamDiscoveryDomain

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

Syntax

Parameter Set: Add0
Add-IpamDiscoveryDomain [-Name] <String> [-CimSession <CimSession[]> ] [-DiscoverDc <Boolean> ] [-DiscoverDhcp <Boolean> ] [-DiscoverDns <Boolean> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]




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

-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

none

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

none

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

none

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

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

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

<WorkflowParameters>

This cmdlet supports the following workflow common parameters: -PSParameterCollection, -PSComputerName, -PSCredential, -PSConnectionRetryCount, -PSConnectionRetryIntervalSec, -PSRunningTimeoutSec, -PSElapsedTimeoutSec, -PSPersist, -PSAuthentication, -PSAuthenticationLevel, -PSApplicationName, -PSPort, -PSUseSSL, -PSConfigurationName, -PSConnectionURI, -PSAllowRedirection, -PSSessionOption, -PSCertificateThumbprint, -PSPrivateMetadata, -AsJob, -JobName, and –InputObject. For more information, see    about_WorkflowCommonParameters.

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



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



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


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

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.

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


PS C:\> Add-IpamDiscoveryDomain -Name "child01.contoso.com" -PassThru

Related topics

Community Additions

ADD
Show: