Set-Ipam Discovery Domain

Module:
ipamserver
Modifies the IPAM discovery configuration.

Syntax 

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

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.

Examples

Example 1: Modify an existing discovery domain 

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

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

contoso.com                   False                         True                          True

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. The command includes the PassThru parameter, so it displays results to the console.

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

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

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

contoso.com                   True                          True                          True

This command modifies an existing discovery domain in IPAM to discover an additional server type in the domain. The command includes the PassThru parameter, so it displays results to the console.

Required Parameters

-Name

Specifies the fully qualified domain name (FQDN) of an Active Directory domain in which to modify the discovery settings.

Type: String
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

Optional 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
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
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
Accept pipeline input: False
Accept wildcard characters: False
-DiscoverDc

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

Type: Boolean
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-DiscoverDhcp

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

Type: Boolean
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-DiscoverDns

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

Type: Boolean
Position: Named
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.

Type: SwitchParameter
Position: Named
Default value: None
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
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
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 discover infrastructure servers.