About Help

Choose a topic from the list on the left or search for a specific topic. Choose a topic from the list or search for a specific topic.
Cmdlets  Providers  Aliases  Modules
 

about_SPSearchTopology

Spsearchtopology

SharePointDSC
 

SHORT DESCRIPTION

 

.NAME

    SPSearchTopology 
 
# Description 
     
    This resource is responsible for provisioning a search topology in to the 
    current farm. It allows the configuration to dictate the search topology roles 
    that the current server should be running. Any combination of roles can be 
    specified and the topology will be upaded to reflect the current servers new 
    roles. If this is the first server to apply topology to a farm, then at least 
    one search index must be provided. To this end, the FirstPartitionIndex, 
    FirstPartitionDirectory and FirstPartitionServers allow configuring where the 
    first index partition will belong. This will behave the same as the 
    SPSearchIndexPartition resource. 
     
    Note that for the search topology to apply correctly, the path specified for 
    FirstPartitionDirectory 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 ServiceAppName 
    Key - String 
    The name of the search service application for this topology 
 
.PARAMETER Admin 
    Required - String 
    A list of servers that will run the admin component 
 
.PARAMETER Crawler 
    Required - String 
    A list of servers that will run the crawler component 
 
.PARAMETER ContentProcessing 
    Required - String 
    A list of servers that will run the content processing component 
 
.PARAMETER AnalyticsProcessing 
    Required - String 
    A list of servers that will run the analytics processing component 
 
.PARAMETER QueryProcessing 
    Required - String 
    A list of servers that will run the query processing component 
 
.PARAMETER IndexPartition 
    Required - String 
    A list of servers that will host the first (0) index partition 
 
.PARAMETER FirstPartitionDirectory 
    Required - String 
    The local directory servers will use to store the first index partition 
 
.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 apply a specific topology to the search service app 
 
 
    Configuration Example  
    { 
        param( 
            [Parameter(Mandatory = $true)] 
            [PSCredential] 
            $SetupAccount 
        ) 
        Import-DscResource -ModuleName SharePointDsc 
 
        node localhost { 
            SPSearchTopology LocalSearchTopology 
            { 
                ServiceAppName          = "Search Service Application" 
                Admin                   = @("Server1","Server2") 
                Crawler                 = @("Server1","Server2") 
                ContentProcessing       = @("Server1","Server2") 
                AnalyticsProcessing     = @("Server1","Server2") 
                QueryProcessing         = @("Server3","Server4") 
                PsDscRunAsCredential    = $SetupAccount 
                FirstPartitionDirectory = "I:\SearchIndexes\0" 
                IndexPartition          = @("Server3","Server4") 
            } 
        } 
    }