Export (0) Print
Expand All
Expand Minimize

Set-SPEnterpriseSearchCrawlRule

Published: May 12, 2010

Sets properties for a crawl rule.

Set-SPEnterpriseSearchCrawlRule [-Identity] <CrawlRulePipeBind> [-AccountName <String>] [-AccountPassword <SecureString>] [-AssignmentCollection <SPAssignmentCollection>] [-AuthenticationType <Nullable>] [-Confirm [<SwitchParameter>]] [-ContentClass <String>] [-CrawlAsHttp <Nullable>] [-FollowComplexUrls <Nullable>] [-IsAdvancedRegularExpression <Nullable>] [-PluggableSecurityTimmerId <Nullable>] [-Priority <Nullable>] [-SearchApplication <SearchServiceApplicationPipeBind>] [-SuppressIndexing <Nullable>] [-Type <Nullable>] [-WhatIf [<SwitchParameter>]]

Parameters

 

Parameter Required Type Description

Identity

Required

Microsoft.Office.Server.Search.Cmdlet.CrawlRulePipeBind

Specifies the name of the crawl rule.

The type must be a valid crawl rule URL, such as http://server_name, or an instance of a valid CrawlRule 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 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.

AuthenticationType

Optional

System.Nullable

Specifies one of the following authentication types:

BasicAccountRuleAccess   Specifies basic authentication.

CertificateRuleAccess   Specifies the X.509 certificate name.

NTLMAccountRuleAccess   Specifies the account name for integrated authentication.

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

ContentClass

Optional

System.String

Specifies a string that is sent to the protocol handler for any content that matches the crawl rule.

CrawlAsHttp

Optional

System.Nullable

Specifies whether the crawler crawls content from a hierarchical content source as HTTP content.

FollowComplexUrls

Optional

System.Nullable

Specifies whether the index engine crawls content from URLs that contain a question mark (?).

IsAdvancedRegularExpression

Optional

System.Nullable

Specifies whether the rule has full regular expression syntax.

The default value is False.

PluggableSecurityTimmerId

Optional

System.Nullable

Specifies the ID of the custom pluggable security trimmer to use, if registered.

Priority

Optional

System.Nullable

Defines where in the list of crawl rules this crawl rule is to be applied.

The priority value cannot be less than 0 or greater than or equal to the number of crawl rules for the search application.

SearchApplication

Optional

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

The name of the search application that is associated with the crawl rule to be modified.

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.

SuppressIndexing

Optional

System.Nullable

Specifies whether the crawler excludes the content of items, to which this rule applies, from the content index.

Type

Optional

System.Nullable

Specifies the type of crawl rule. A value of zero (0) includes the rule, and a value of 1 excludes the rule.

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

A search administrator runs the Set-SPEnterpriseSearchCrawlRule cmdlet at initial search configuration or any other time, to set or update various attributes of a crawl rule.

Input Types

 

Return Types

 

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

$crawlRule = Get-SPEnterpriseSearchCrawlRule –Identity
file://fileserver/root -SearchApplication mySearchServiceApp
Set-SPEnterpriseSearchCrawlRule -Identity $crawlRule -Type "ExclusionRule"

This example sets the type of the crawl rule pertaining to the URL, file://fileserver/root, to exclude this path from future crawls.

Change History

 

Date Description Reason

May 12, 2010

Initial publication

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft