Set-SPEnterpriseSearchCrawlContentSource

 

Applies to: SharePoint Server 2010

Topic Last Modified: 2010-05-07

Sets the properties of a crawl content source for a shared search application.

Syntax

Set-SPEnterpriseSearchCrawlContentSource [-Identity] <ContentSourcePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-BDCApplicationProxyGroup <SPServiceApplicationProxyGroupPipeBind>] [-Confirm [<SwitchParameter>]] [-CrawlPriority <Nullable>] [-CustomProtocol <String>] [-LOBSystemSet <String[]>] [-MaxPageEnumerationDepth <Nullable>] [-MaxSiteEnumerationDepth <Nullable>] [-Name <String>] [-SearchApplication <SearchServiceApplicationPipeBind>] [-StartAddresses <String>] [-Tag <String>] [-WhatIf [<SwitchParameter>]]

Set-SPEnterpriseSearchCrawlContentSource [-Identity] <ContentSourcePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-BDCApplicationProxyGroup <SPServiceApplicationProxyGroupPipeBind>] [-Confirm [<SwitchParameter>]] [-CrawlPriority <Nullable>] [-CustomProtocol <String>] [-LOBSystemSet <String[]>] [-MaxPageEnumerationDepth <Nullable>] [-MaxSiteEnumerationDepth <Nullable>] [-Name <String>] [-RemoveCrawlSchedule <SwitchParameter>] [-ScheduleType <Nullable>] [-SearchApplication <SearchServiceApplicationPipeBind>] [-StartAddresses <String>] [-Tag <String>] [-WhatIf [<SwitchParameter>]]

Set-SPEnterpriseSearchCrawlContentSource [-Identity] <ContentSourcePipeBind> -ScheduleType <Nullable> [-AssignmentCollection <SPAssignmentCollection>] [-BDCApplicationProxyGroup <SPServiceApplicationProxyGroupPipeBind>] [-Confirm [<SwitchParameter>]] [-CrawlPriority <Nullable>] [-CrawlScheduleRepeatDuration <Nullable>] [-CrawlScheduleRepeatInterval <Nullable>] [-CrawlScheduleRunEveryInterval <Nullable>] [-CrawlScheduleStartDateTime <Nullable>] [-CustomProtocol <String>] [-DailyCrawlSchedule <SwitchParameter>] [-LOBSystemSet <String[]>] [-MaxPageEnumerationDepth <Nullable>] [-MaxSiteEnumerationDepth <Nullable>] [-Name <String>] [-SearchApplication <SearchServiceApplicationPipeBind>] [-StartAddresses <String>] [-Tag <String>] [-WhatIf [<SwitchParameter>]]

Set-SPEnterpriseSearchCrawlContentSource [-Identity] <ContentSourcePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-BDCApplicationProxyGroup <SPServiceApplicationProxyGroupPipeBind>] [-Confirm [<SwitchParameter>]] [-CrawlPriority <Nullable>] [-CrawlScheduleDaysOfMonth <Nullable>] [-CrawlScheduleMonthsOfYear <Nullable>] [-CrawlScheduleRepeatDuration <Nullable>] [-CrawlScheduleRepeatInterval <Nullable>] [-CrawlScheduleStartDateTime <Nullable>] [-CustomProtocol <String>] [-LOBSystemSet <String[]>] [-MaxPageEnumerationDepth <Nullable>] [-MaxSiteEnumerationDepth <Nullable>] [-MonthlyCrawlSchedule <SwitchParameter>] [-Name <String>] [-ScheduleType <Nullable>] [-SearchApplication <SearchServiceApplicationPipeBind>] [-StartAddresses <String>] [-Tag <String>] [-WhatIf [<SwitchParameter>]]

Set-SPEnterpriseSearchCrawlContentSource [-Identity] <ContentSourcePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-BDCApplicationProxyGroup <SPServiceApplicationProxyGroupPipeBind>] [-Confirm [<SwitchParameter>]] [-CrawlPriority <Nullable>] [-CrawlScheduleDaysOfWeek <Nullable>] [-CrawlScheduleRepeatDuration <Nullable>] [-CrawlScheduleRepeatInterval <Nullable>] [-CrawlScheduleRunEveryInterval <Nullable>] [-CrawlScheduleStartDateTime <Nullable>] [-CustomProtocol <String>] [-LOBSystemSet <String[]>] [-MaxPageEnumerationDepth <Nullable>] [-MaxSiteEnumerationDepth <Nullable>] [-Name <String>] [-ScheduleType <Nullable>] [-SearchApplication <SearchServiceApplicationPipeBind>] [-StartAddresses <String>] [-Tag <String>] [-WeeklyCrawlSchedule <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Detailed Description

This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets.

The Set-SPEnterpriseSearchCrawlContentSource cmdlet updates the rules of a crawl content source when the search functionality is initially configured and after any new content source is added. This cmdlet is called once to set the incremental crawl schedule for a content source, and it is called again to set a full crawl schedule.

Parameters

Parameter Required Type Description

Identity

Optional

Microsoft.Office.Server.Search.Cmdlet.ContentSourcePipeBind

Specifies the crawl content source to update.

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

ScheduleType

Required

System.Nullable

Specifies the type of crawl schedule.

The type must be one of the following values: Full or Incremental.

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.

BDCApplicationProxyGroup

Optional

Microsoft.SharePoint.PowerShell.SPServiceApplicationProxyGroupPipeBind

Specifies the proxy to use for a business type content source. This proxy group must contain a default Business Data Connectivity Metadata Store proxy.

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

CrawlPriority

Optional

System.Nullable

Specifies the priority of this content source.

The type must be one of the following integers: 1= Normal, 2=High.

CrawlScheduleDaysOfMonth

Optional

System.Nullable

Specifies the days on which to crawl when the MonthlyCrawlSchedule parameter is set.

CrawlScheduleDaysOfWeek

Optional

System.Nullable

Specifies the days on which to crawl when the WeeklyCrawlSchedule parameter is set.

CrawlScheduleMonthsOfYear

Optional

System.Nullable

Specifies the months on which to crawl when the MonthlyCrawlSchedule parameter is set.

CrawlScheduleRepeatDuration

Optional

System.Nullable

Specifies the number of times to repeat the crawl schedule.

CrawlScheduleRepeatInterval

Optional

System.Nullable

Specifies the number of minutes between each repeat interval for the crawl schedule

CrawlScheduleRunEveryInterval

Optional

System.Nullable

Specifies the interval between crawls.

When the DailyCrawlSchedule parameter is set, specifies the number of days between crawls.

When the WeeklyCrawlSchedule parameter is set, specifies the number of weeks between crawls.

CrawlScheduleStartDateTime

Optional

System.Nullable

Specifies the initial date of the crawl. The default value is midnight on the current day.

CustomProtocol

Optional

System.String

Specifies the custom protocol, handled by the custom connector, to use for this content source.

DailyCrawlSchedule

Optional

System.Management.Automation.SwitchParameter

Base schedule on days between crawls.

LOBSystemSet

Optional

System.String[]

Specifies a comma-separated list of Business Data Connectivity Metadata Store system names and system instance names for a business type content source.

MaxPageEnumerationDepth

Optional

System.Nullable

Specifies, for a web or custom type content source, the number of page hops that the crawler can make from the start address to a content item.

MaxSiteEnumerationDepth

Optional

System.Nullable

Specifies, for a web or custom type content source, the number of site hops that the crawler can take from the start address to a content item.

MonthlyCrawlSchedule

Optional

System.Management.Automation.SwitchParameter

Base the schedule on months between crawls.

Name

Optional

System.String

Specifies the new display name for the content source.

The type must be a valid name of a content source; for example, ContentSource1.

RemoveCrawlSchedule

Optional

System.Management.Automation.SwitchParameter

Deletes the specified crawl.

SearchApplication

Optional

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

Specifies the search application that contains the content source.

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.

StartAddresses

Optional

System.String

Specifies the comma-separated list of URLs at which to start a crawl for this content source.

The type must be a valid URL, in the form http://server_name.

Tag

Optional

System.String

Specifies the URL for the page to modify the settings for a custom content source. The string that specifies the URL can contain a maximum of 1,024 characters.

The type must be a valid URL, in the form http://server_name.

WeeklyCrawlSchedule

Optional

System.Management.Automation.SwitchParameter

Base the schedule on weeks between crawls.

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

$searchapp = Get-SPEnterpriseSearchServiceApplication "SearchApp1"
$cs = Get-SPEnterpriseSearchCrawlContentSource -SearchApplication $searchapp ""
$cs | Set-SPEnterpriseSearchCrawlContentSource -ScheduleType Full -DailyCrawlSchedule -CrawlScheduleRunEveryInterval 30
$cs | Set-SPEnterpriseSearchCrawlContentSource -ScheduleType Incremental -DailyCrawlSchedule -CrawlScheduleRepeatInterval 60 -CrawlScheduleRepeatDuration 1440

This example returns an existing content source ExampleContentSource1, and creates a schedule to run a full crawl every 30 days and an incremental crawl every hour every day.