Description

This cmdlet retrieves the search component with the specified identity from the given search topology.
If an identity is not provided, all search components in the given search topology will be retrieved.

This example retrieves the search component with the identity 06e6651d-ecdd-4105-bb65-6a83b6155525 from the search topology with identity 56e6651d-ecdd-4105-bb65-6a83b6155525 in the search service application referenced by $ssa.

This example retrieves all search components from the search topology with the identity 56e6651d-ecdd-4105-bb65-6a83b6155525 in the search service application referenced by $ssa.

Required Parameters

-SearchTopology

Specifies the search topology from which to retrieve the search component/search components.

Type:

SearchTopologyPipeBind

Position:

Named

Default value:

None

Accept pipeline input:

True (ByValue)

Accept wildcard characters:

False

Applies to:

SharePoint Server 2013, SharePoint Server 2016

Optional Parameters

-AssignmentCollection

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.

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.

Type:

SPAssignmentCollection

Position:

Named

Default value:

None

Accept pipeline input:

True (ByValue)

Accept wildcard characters:

False

Applies to:

SharePoint Server 2013, SharePoint Server 2016

-Identity

Specifies the identity for a search component.

Type:

SearchComponentPipeBind

Position:

1

Default value:

None

Accept pipeline input:

False

Accept wildcard characters:

False

Applies to:

SharePoint Server 2013, SharePoint Server 2016

-SearchApplication

Specifies the search service application that contains the search topology and search component/search components.

Type:

SearchServiceApplicationPipeBind

Position:

Named

Default value:

None

Accept pipeline input:

False

Accept wildcard characters:

False

Applies to:

SharePoint Server 2013, SharePoint Server 2016

Note

The feedback system for this content will be changing soon. Old comments will not be carried over. If content within a comment thread is important to you, please save a copy. For more information on the upcoming change, we invite you to read our blog post.