Article
07/25/2014

Get-SPEnterpriseSearchSiteHitRule

Applies to: SharePoint Server 2010

Topic Last Modified: 2010-02-11

Returns the shared site hit rule.

Syntax

Get-SPEnterpriseSearchSiteHitRule [[-Identity] <SiteHitRulePipeBind>] [-AssignmentCollection <SPAssignmentCollection>] [-SearchService <SearchServicePipeBind>]

Detailed Description

The Get-SPEnterpriseSearchSiteHitRule cmdlet reads a SiteHitRule object when the site hit rule is created, updated, or deleted. A SiteHitRule object sets how many crawler sessions (threads) can simultaneously crawl the given site.

If the Identity parameter is not specified, this cmdlet returns the site hit rule collection for the specified search application.

Parameters

Parameter	Required	Type	Description
Identity	Optional	Microsoft.Office.Server.Search.Cmdlet.SiteHitRulePipeBind	Specifies the site hit rule to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SiteHitRule object.
SearchService	Required	Microsoft.Office.Server.Search.Cmdlet.SearchServicePipeBind	Specifies the search service that hosts the crawler with the specified shared site search rules. 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.
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.

Identity

Optional

Microsoft.Office.Server.Search.Cmdlet.SiteHitRulePipeBind

Specifies the site hit rule to get.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SiteHitRule object.

SearchService

Required

Microsoft.Office.Server.Search.Cmdlet.SearchServicePipeBind

Specifies the search service that hosts the crawler with the specified shared site search rules.

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.

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.

Input Types

Return Types

Example

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

$shRule = Get-SPEnterpriseSearchSiteHitRule -Identity MySiteHitRule

The following example obtains a reference to the site hit rule with the name MySiteHitRule.