Share via


Get-SPEnterpriseSearchCrawlTopology

 

Applies to: SharePoint Server 2010 Standard, SharePoint Server 2010 Enterprise

Topic Last Modified: 2010-02-11

Returns a crawl topology.

Syntax

Get-SPEnterpriseSearchCrawlTopology [[-Identity] <CrawlTopologyPipeBind>] -SearchApplication <SearchServiceApplicationPipeBind> [-Active <SwitchParameter>] [-AssignmentCollection <SPAssignmentCollection>]

Detailed Description

The Get-SPEnterpriseSearchCrawlTopology cmdlet returns a crawl topology for a search application. A crawl topology contains the crawl component collection for a topology.

If the Identity parameter is not specified, this cmdlet returns the crawl topology collection for the specified search application.

Parameters

Parameter Required Type Description

Identity

Optional

Microsoft.Office.Server.Search.Cmdlet.CrawlTopologyPipeBind

Specifies the crawl topology to get.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid CrawlTopology object.

SearchApplication

Required

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

Specifies the search application that contains the crawl topology collection.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object.

Active

Optional

System.Management.Automation.SwitchParameter

Filters to return only active crawl topologies. An active crawl topology is currently serving crawls for the search application.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

Note

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Input Types

Return Types

Example

------------------EXAMPLE------------------

$searchapp = Get-SPEnterpriseSearchServiceApplication "SearchApp1" 
$searchapp | Get-SPEnterpriseSearchCrawlTopology

This example returns all crawl topologies for the search application SearchApp1.