This topic has not yet been rated - Rate this topic

New-SPEnterpriseSearchServiceApplication

SharePoint 2013

Published: July 16, 2012

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

Adds a search service application to a farm.

New-SPEnterpriseSearchServiceApplication [[-Name] <String>] -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> [-AdminApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-DatabaseName <String>] [-DatabasePassword <SecureString>] [-DatabaseServer <String>] [-DatabaseUsername <String>] [-FailoverDatabaseServer <String>] [-Partitioned <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter

Required

Type

Description

Name

Required

System.String

Specifies the names of the new search application.

The type must be a valid name of a search application, for example, SearchApp1.

ApplicationPool

Required

Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind

Specifies the IIS application pool to use for the new search application.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL of a search application, in the form http://server_name; or an instance of a valid SPIisWebServiceApplicationPool object.

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.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

DatabaseName

Optional

System.String

Specifies the name of the database to create for the new search application.

The type must be a valid name of a SQL Server database, for example, SearchAppDB1.

DatabasePassword

Optional

System.String

Specifies the password for the user ID that is used for accessing the search application database on SQL Server.

The type must be a valid password.

DatabaseServer

Optional

System.String

Specifies the name of the host server for the database specified in DatabaseName.

The type must be a valid SQL Server host name, for example, SQLServerHost1.

DatabaseUsername

Optional

System.String

Specifies the user ID to use for accessing the search application SQL Server database.

The type must be a valid user name, for example, SearchUserName1.

Partitioned

Optional

System.Management.Automation.SwitchParameter

Specifies that the search service application uses web-hosted mode. web-hosted mode segregates results for a given hosted subscription.

WhatIf

Optional

System.Management.Automation.SwitchParameter

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

Detailed Description

This cmdlet is used when the search functionality is first configured or when a new shared search application is added to a farm. SPEnterpriseSearchServiceApplication represents a self-contained aggregation of indexed content and properties available for search, and provides an anchor class for setting global search properties. A farm can include multiple search service applications.

Input Types

Return Types

Example

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

$appPool = New-SPServiceApplicationPool -name "SsaAppPool" -account contoso\adminUser

$ssa = New-SPEnterpriseSearchServiceApplication -Name "NewSSA" -ApplicationPool $appPool

This example creates a new search service application named NewSSA in a new application pool. A search service application that is created in this manner will have active search topology, but no search components.