en-us/about_xSPJoinFarm.help.txt

NAME
    xSPJoinFarm
 
PARAMETERS
    FarmConfigDatabaseName (Key, string)
    DatabaseServer (Key, string)
    InstallAccount (Write, String)
    Passphrase (Required, string)
    ServerRole (Write, string, Allowed values: Application, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, SpecialLoad, WebFrontEnd)
 
DESCRIPTION
 
This resource will be responsible for joining a server to an existing SharePoint farm.
To create a new farm use the [xSPCreateFarm](xSPCreateFarm) resource on a different server to begin with, and then pass the same database server and configuration database name parameters to the additional servers using this resource.
After the server has joined the farm, the process will wait for 5 minutes to allow farm specific configuration to take place on the server, before allowing further DSC configuration to take place.
 
EXAMPLE
 
    xSPJoinFarm JoinSPFarm
    {
        DatabaseServer = $DatabaseServer
        FarmConfigDatabaseName = "SP_Config"
        Passphrase = $FarmPassPhrase
        PsDscRunAsCredential = $InstallAccount
    }