This topic has not yet been rated - Rate this topic

Get-SPEnterpriseSearchTopology

SharePoint 2013

Published: July 16, 2012

Applies to: SharePoint Server 2013 Enterprise | SharePoint Server 2013 Standard

Retrieves one or all search topologies that belong to a given search service application.

Get-SPEnterpriseSearchTopology [[-Identity] <SearchTopologyPipeBind>] -SearchApplication <SearchServiceApplicationPipeBind> [-Active <SwitchParameter>] [-AssignmentCollection <SPAssignmentCollection>]

Parameters

Parameter

Required

Type

Description

Identity

Optional

Microsoft.Office.Server.Search.Cmdlet.SearchTopologyPipeBind

Specifies the search topology to retrieve.

SearchApplication

Required

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

Specifies the search application to which the search topology belongs.

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

Specifies that the active search topology should be returned.

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.

Detailed Description

This cmdlet retrieves a given search topology, the active search topology, or all search topologies that belong to a given search service application.

Input Types

Return Types

Example

------------------EXAMPLE 1------------------

$ssa = Get-SPEnterpriseSearchServiceApplication

Get-SPEnterpriseSearchTopology –SearchApplication $ssa

This example retrieves all search topologies of the search service application referenced by $ssa.

------------------EXAMPLE 2------------------

$ssa = Get-SPEnterpriseSearchServiceApplication

Get-SPEnterpriseSearchTopology –SearchApplication $ssa -Active

This example retrieves the active search topology of the search service application referenced by $ssa.

------------------EXAMPLE 3------------------

$ssa = Get-SPEnterpriseSearchServiceApplication

Get-SPEnterpriseSearchTopology –SearchApplication $ssa –Identity 10fa59cb-4b32-4fe6-8f8d-065388df201e

This example retrieves search topology with the identity 10fa59cb-4b32-4fe6-8f8d-065388df201e of the search service application referenced by $ssa.