Get-SPEnterpriseSearchCrawlRule
Applies to: SharePoint Server 2010
Topic Last Modified: 2010-02-11
Accesses crawl rules.
Syntax
Get-SPEnterpriseSearchCrawlRule [[-Identity] <CrawlRulePipeBind>] -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>]
Detailed Description
Use the Get-SPEnterpriseSearchCrawlRule cmdlet for a search administrator to run this procedure to retrieve the crawl rule when the crawl rule is updated or deleted.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
Microsoft.Office.Server.Search.Cmdlet.CrawlRulePipeBind |
Specifies the search crawl rule path. A valid URL, such as "http://server_name", or an instance of a valid CrawlRule object |
SearchApplication |
Required |
Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind |
Specifies the search application that contains the crawl rule. 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 1-----------------
$searchApp = Get-SPEnterpriseSearchServiceApplication ExampleSearchServiceApplication
$crawlRule = Get-SPEnterpriseSearchCrawlRule -SearchApplication $searchApp -Identity http://example
$crawlRule | Set-SPEnterpriseSearchCrawlRule -Type InclusionRule
This example uses the Get-SPEnterpriseSearchCrawlRule cmdlet to retrieve a crawl rule in order to change its type from ExclusionRule to InclusionRule.
---------------EXAMPLE 2---------------
$searchApp = Get-SPEnterpriseSearchServiceApplication MySearchServiceApp Get-SPEnterpriseSearchCrawlRule -SearchApplication $searchApp | where
{$_.Path -like "*example*"}
This example returns a list of crawl rules with paths that contain the word example from the search service application named, MySearchServiceApp.