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
 

Set-IpamDiscoveryDomain

Set-IpamDiscoveryDomain

ipamdiscoverydomain.cdxml

Synopsis

Modifies the IPAM discovery configuration.

Syntax

Set-IpamDiscoveryDomain [-Name] [-AsJob] [-CimSession] [-DiscoverDc] [-DiscoverDhcp] [-DiscoverDns] [-PassThru] [-ThrottleLimit] [-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 <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 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 <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: 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

Online Version
Add-IpamDiscoveryDomain
Get-IpamDiscoveryDomain
Remove-IpamDiscoveryDomain