SPSearchContentSource

SPSearchContentSource

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	The name of the content source
ServiceAppName	Key	String	The name of the search service app that this content source exists within
ContentSourceType	Required	String	The type of content source - currently only SharePoint, Website, File Shares and Business are supported	SharePoint, Website, FileShare, Business
Addresses	Write	String[]	A list of the addresses this content source includes
CrawlSetting	Write	String	Should the crawler index everything, just the first site or page, or a custom depth (applies to websites only)	CrawlEverything, CrawlFirstOnly, Custom
ContinuousCrawl	Write	Boolean	Should this content source use continuous crawl (SharePoint sites only)
IncrementalSchedule	Write	String	What is the incremental schedule for this content source
FullSchedule	Write	String	What is the full schedule for this content source
Priority	Write	String	What is the priority on this content source	Normal, High
LimitPageDepth	Write	Uint32	How many pages deep should the crawler go (-1 = unlimited, website sources only)
LimitServerHops	Write	Uint32	How many server hops should the crawler make (-1 = unlimtied, website sources only)
LOBSystemSet	Write	String[]	Line of Business System and System Instance names
Ensure	Write	string	Present if the source should exist, absent if it should not	Present, Absent
Force	Write	Boolean	Specify true if DSC is allowed to delete and recreate a content source to apply the correct settings, otherwise false will just report errors if a change can not be applied.
InstallAccount	Write	PSCredential	POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5

Description

Type: Distributed Requires CredSSP: No

This resource will deploy and configure a content source in a specified search service application.

The default value for the Ensure parameter is Present. When not specifying this parameter, the content source is created.

Examples

Example 1

This example shows how to create a SharePoint sites content source

    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPSearchContentSource LocalSharePointSites
            {
                Name                 = "Local SharePoint Sites"
                ServiceAppName       = "Search Service Application"
                ContentSourceType    = "SharePoint"
                Addresses            = @("http://sharepointsite1.contoso.com", "http://sharepointsite2.contoso.com")
                CrawlSetting         = "CrawlEverything"
                ContinuousCrawl      = $true
                FullSchedule         = $null
                Priority             = "Normal"
                Ensure               = "Present"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }

Example 2

This example shows how to create a website content source

    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPSearchContentSource WebsiteSource
            {
                Name                 = "Contoso website"
                ServiceAppName       = "Search Service Application"
                ContentSourceType    = "Website"
                Addresses            = @("http://www.contoso.com")
                CrawlSetting         = "Custom"
                LimitPageDepth       = 5
                IncrementalSchedule  = MSFT_SPSearchCrawlSchedule{
                                        ScheduleType = "Daily"
                                        StartHour = "0"
                                        StartMinute = "0"
                                        CrawlScheduleRepeatDuration = "1440"
                                        CrawlScheduleRepeatInterval = "5"
                                       }
                FullSchedule         = MSFT_SPSearchCrawlSchedule{
                                        ScheduleType = "Weekly"
                                        CrawlScheduleDaysOfWeek = @("Monday", "Wednesday", "Friday")
                                        StartHour = "3"
                                        StartMinute = "0"
                                       }
                Priority             = "Normal"
                Ensure               = "Present"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }