en-US/about_SPSearchIndexPartition.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
.NAME
    SPSearchIndexPartition

# Description
    
    This resource is responsible for creating search indexes. It works by creating
    the index topology components and updating the topology from the server that
    runs this resource. For this reason this resource only needs to run from one
    server and not from each server which will host the index component. The
    search service application and existing search topology must be deployed
    before creating additional indexes. The first index will be created through
    the use of the SPSearchRoles resource. Additional search index partitions can
    be created through using this resource.
    
    Note that for the search topology to apply correctly, the path specified for
    RootDirectory needs to exist on the server that is executing this resource. For
    example, if the below example was executed on "Server1" it would also need to
    ensure that it was able to create the index path at I:\. If no disk labeled I:
    was available on server1, this would fail, even though it will not hold an
    actual index component.
    
.PARAMETER Index
    Key - Uint32
    The number of the partition in this farm

.PARAMETER Servers
    Required - String
    A list of the servers that this partition should exist on

.PARAMETER RootDirectory
    Write - String
    The directory that the index should use locally on each server to store data

.PARAMETER ServiceAppName
    Key - String
    The name of the search service application

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


.EXAMPLE
    This example adds an extra search partition to the local farms topology


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

        node localhost {
            SPSearchIndexPartition AdditionalPartition
            {
                Servers              = @("Server2", "Server3")
                Index                = 1
                RootDirectory        = "I:\SearchIndexes\1"
                ServiceAppName       = "Search Service Application"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }