Set-SPEnterpriseSearchServiceApplication

 

Applies to: SharePoint Server 2010

Topic Last Modified: 2010-02-11

Sets the properties of a search service application for a farm.

Syntax

Set-SPEnterpriseSearchServiceApplication [-Identity] <SearchServiceApplicationPipeBind> [-AdminApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-DatabaseName <String>] [-DatabasePassword <SecureString>] [-DatabaseServer <String>] [-DatabaseUsername <String>] [-DefaultContentAccessAccountName <String>] [-DefaultContentAccessAccountPassword <SecureString>] [-DefaultSearchProvider <Nullable>] [-DiacriticSensitive <String>] [-FailoverDatabaseServer <String>] [-VerboseQueryMonitoring <String>] [-WhatIf [<SwitchParameter>]]

Detailed Description

The Set-SPEnterpriseSearchServiceApplication cmdlet updates properties of a search service application. 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 search application can include multiple search service applications.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

Specifies the search service application to update.

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.

AdminApplicationPool

Optional

Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind

Specifies the application pool for the administrative Web service for the search service application.

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

ApplicationPool

Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind

Specifies an application pool for the search service application.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPool1); or an instance of a valid IISWebServiceApplicationPool 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 for the Web service administration.

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

DatabasePassword

Optional

System.String

Specifies the password for the user ID that is used for accessing the Web service administration database on SQL Server.

The type must be a valid password.

DatabaseServer

Optional

System.String

Specifies the name of the host server for the Web service administration database.

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 Web service administration database.

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

DefaultContentAccessAccountName

Optional

System.String

Specifies the account ID to use for accessing content.

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

DefaultContentAccessAccountPassword

Optional

System.Security.SecureString

Specifies the password for the content access account.

The type must be a valid password.

DefaultSearchProvider

Optional

System.Nullable

Specifies the search application type to be used for this application:

0 = Default

1 = SharePoint Search

2 = Extended Search

DiacriticSensitive

Optional

System.String

Specifies that the search application respects diacritics (for example, ä).

FailoverDatabaseServer

Optional

System.String

Specifies the name of the host SQL instance for the failover database server.

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

VerboseQueryMonitoring

Optional

System.String

Enables verbose query monitoring. The default value is False.

The type must be a string that can be cast to a Boolean value; for example, True or False.

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

Input Types

Return Types

Example

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

Set-SPEnterpriseSearchServiceApplication -Identity MySSA -VerboseQueryMonitoring True

This example turns on verbose query logging in the search service application named MySSA.