Export (0) Print
Expand All
Expand Minimize

Set-IpamDiscoveryDomain

Windows Server 2012 R2 and Windows 8.1

Updated: December 18, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Set-IpamDiscoveryDomain

Modifies the IPAM discovery configuration.

Syntax

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




Detailed Description

The Set-IpamDiscoveryDomain cmdlet modifies the discovery configuration for an Active Directory domain. Use this cmdlet to configure IPAM to discover particular types of servers, such as domain controllers, Dynamic Host Configuration Protocol (DHCP) servers, or Domain Name System (DNS) servers.

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.


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 domain controller servers in a 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 DHCP servers in a 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 DNS servers in a 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 an Active Directory domain in which to modify the discovery settings.


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: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

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 will discover infrastructure servers.



Examples

Example 1: Modify an existing discovery domain

This command modifies an existing discovery domain to prevent server discovery of domain controllers in the domain. The command outputs an object for use with another cmdlet.


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

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

contoso.com False True True

Example 2: Modify an existing discovery domain to discover domain controllers

This command modifies an existing discovery domain in IPAM to discover an additional server type in the domain.


PS C:\> Set-IpamDiscoveryDomain -Name contoso.com -DiscoverDc $True -PassThru
DomainName                    DiscoverDc                    DiscoverDns                   DiscoverDhcp

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

contoso.com True True True

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft