New-SPEnterpriseSearchSiteHitRule

 

Applies to: SharePoint Server 2010

Topic Last Modified: 2010-02-11

Adds a new site hit rule for a search application.

Syntax

New-SPEnterpriseSearchSiteHitRule [-Name] <String> -Behavior <String> -HitRate <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-SearchService <SearchServicePipeBind>] [-WhatIf [<SwitchParameter>]]

Detailed Description

The New-SPEnterpriseSearchSiteHitRule cmdlet sets the maximum limits for crawling a site. The new site hit rule is used by all search service applications on the current farm.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Office.Server.Search.Cmdlet.SiteHitRulePipeBind

The name of the host to which the site hit rule should be applied.

Behavior

Required

System.String

Defines a rule to be followed when the farm’s search service crawls the given site. If a value of zero is specified, the hit rate is the maximum number of simultaneous requests. If a value of 1 is specified, then hit rate is the number of seconds to delay between requests to the server.

HitRate

Required

System.String

Value to use for maximum requests or seconds of delay, according to behavior.

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

SearchService

Optional

Microsoft.Office.Server.Search.Cmdlet.SearchServicePipeBind

Specifies the search service in the farm that hosts the crawl.

The type must be an instance of a valid SearchService object; otherwise, the local service on the server that hosts the Windows PowerShell cmdlet will be used.

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------------------

New-SPEnterpriseSearchSiteHitRule -Identity myHost -Behavior 0 
-HitRate 40

This example creates a new site hit rule on the myHost host that limits to 40 the number of simultaneous requests.