Invoke-CMForestDiscovery

Invoke-CMForestDiscovery

Starts a forest discovery operation in Active Directory.

Syntax

Parameter Set: SearchBySiteCodeMandatory
Invoke-CMForestDiscovery -SiteCode <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Invoke-CMForestDiscovery cmdlet starts a forest discovery operation in Active Directory. A forest discovery returns a list of Active Directory sites, subnets, and domains.

Parameters

-SiteCode<String>

Specifies the site that is the starting point for the forest discovery operation.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).

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.

Examples

Example 1: Invoke a forest discovery operation

This command invokes a forest discovery operation in Active Directory starting at the site that has the site code ContosoCM4.

PS C:\> Invoke-CMForestDiscovery -SiteCode "ContosoCM4"