en-US/about_SPSearchContentSource.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
.NAME
    SPSearchContentSource

# Description
    
    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.
    
.PARAMETER Name
    Key - String
    The name of the content source

.PARAMETER ServiceAppName
    Key - String
    The name of the search service app that this content source exists within

.PARAMETER ContentSourceType
    Required - String
    Allowed values: SharePoint, Website, FileShare
    The type of content source - currently only SharePoint, Website and File Shares are supported

.PARAMETER Addresses
    Required - String
    A list of the addresses this content source includes

.PARAMETER CrawlSetting
    Required - String
    Allowed values: CrawlEverything, CrawlFirstOnly, Custom
    Should the crawler index everything, just the first site or page, or a custom depth (applies to websites only)

.PARAMETER ContinuousCrawl
    Write - Boolean
    Should this content source use continuous crawl (SharePoint sites only)

.PARAMETER IncrementalSchedule
    Write - String
    What is the incremental schedule for this content source

.PARAMETER FullSchedule
    Write - String
    What is the full schedule for this content source

.PARAMETER Priority
    Write - String
    Allowed values: Normal, High
    What is the priority on this content source

.PARAMETER LimitPageDepth
    Write - Uint32
    How many pages deep should the crawler go (-1 = unlimited, website sources only)

.PARAMETER LimitServerHops
    Write - Uint32
    How many server hops should the crawler make (-1 = unlimtied, website sources only)

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present if the source should exist, absent if it should not

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

.PARAMETER InstallAccount
    Write - String
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5


.EXAMPLE
    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
                IncrementalSchedule  = MSFT_SPSearchCrawlSchedule {
                                        ScheduleType = "Daily"
                                        StartHour = "0"
                                        StartMinute = "0"
                                        CrawlScheduleRepeatDuration = "1440"
                                        CrawlScheduleRepeatInterval = "5"
                                       }
                FullSchedule         = $null
                Priority             = "Normal"
                Ensure               = "Present"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }


.EXAMPLE
    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
                LimitServerHops      = 0
                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
            }
        }
    }