Edit

Share via


New-SPEnterpriseSearchTopology

Creates a new search topology in the given search service application.

Syntax

Default (Default)

New-SPEnterpriseSearchTopology
    -SearchApplication <SearchServiceApplicationPipeBind>
    [-AssignmentCollection <SPAssignmentCollection>]
    [-Clone]
    [-Confirm]
    [-SearchTopology <SearchTopologyPipeBind>]
    [-WhatIf]
    [<CommonParameters>]

Description

This cmdlet creates a new, inactive search topology in the given search service application. If the Clone switch is used, a cloned topology is created. Otherwise, an empty topology is created.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

EXAMPLE 1

$ssa = Get-SPEnterpriseSearchServiceApplication
New-SPEnterpriseSearchTopology -SearchApplication $ssa

This example creates a new, empty search topology in the search service application referenced by $ssa.

EXAMPLE 2

$ssa = Get-SPEnterpriseSearchServiceApplication
$topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa
New-SPEnterpriseSearchTopology -SearchApplication $ssa -Clone -SearchTopology $topology

This example creates a new search topology in the search service application referenced by $ssa by cloning the existing topology referenced by $topology.

Parameters

-AssignmentCollection

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Type:SPAssignmentCollection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Clone

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies that the new search topology is to be created by cloning an existing search topology.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies that the new search topology is to be created by cloning an existing search topology.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SearchApplication

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies the search application to which the search topology will belong.

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.

Parameter properties

Type:SearchServiceApplicationPipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-SearchTopology

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies the existing search topology of which the new topology will be a clone.

Parameter properties

Type:SearchTopologyPipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.