Scripted deployment reference (SharePoint Foundation 2010)

Applies to: SharePoint Foundation 2010

This article describes the commands and syntax that is used in scripted deployment of a Microsoft SharePoint Foundation 2010 farm. It also contains a table of common templates used in Install SharePoint Foundation 2010 by using Windows PowerShell.

For information about using these commands to install SharePoint Foundation 2010, see Install SharePoint Foundation 2010 by using Windows PowerShell.

In this article:

• Install-SharePoint

• New-SharePointFarm

• Join-SharePointFarm

• Common site collection templates

Install-SharePoint

The Install-SharePoint command installs SharePoint Foundation 2010 on all servers.

There are two ways—defined by a parameter set—to run the Install-SharePoint command. In the first case, you specify a path for the install files, and many other values to deviate from the default. The second way is to specify the path for the install files, and then the path to a Config.xml file. During Setup, the PIDKey and other settings are parsed in the config.xml file..

The syntax for the Install-SharePoint command is listed below. Note that the result is determined by which parameter set is specified. For the first parameter set, the SetupExePath is required. All other parameters are optional. If no value is specified for the optional LogPath parameter, the default value is %Temp%.

Install-SharePoint -SetupExePath <String> -PIDKey <String> [-LoggingType < Verbose | Off | Standard | Debug>] [-LogPath <String>] [-LogTemplate <String>] [-DisplayLevel <None | Basic | Full>] [-ShowCompletionNotice <SwitchParameter>] [-UseIInstallMode <SwitchParameter>] [-AcceptEula <SwitchParameter>] [-ShowModalDialog <SwitchParameter>] [-AllowCancel <SwitchParameter>] [-ServerRole <APPLICATION | WFE | SINGLESERVER>] [-SetupType <CLEAN_INSTALL | V2V_INPLACE_UPGRADE | B2B_UPGRADE | SKU2SKU_UPGRADE>] [-InstallDirectory <String>] [-DataDirectory <String>] [-RunsWorkaround <SwitchParameter>] [-PhysicalSKU <OfficeServer | SharePoint | SearchServer | SearchServerExpress | WCServer | ProjectServer | SharePointLanguagePack | ServerLanguagePack>]

For the second parameter set, there are two required parameters, SetupExePath and ConfigXMLPath.

Install-SharePoint -SetupExePath <String> -ConfigXMLPath <String> [-PIDKey <String>] [-PhysicalSKU <OfficeServer | SharePoint | SearchServer | SearchServerExpress | WCServer | ProjectServer | SharePointLanguagePack | ServerLanguagePack>]

New-SharePointFarm

The New-SharePointFarm command creates the farm on the server that will be running the Central Administration Web site.

The command performs the following actions:

1. Creates the configuration database.

2. Creates the administration content database.

3. Installs the Help collection.

4. Creates the Central Administration Web application.

5. Copies shared application data to existing Web application folders.

The syntax for the New-SharePointFarm command is listed below and there are two required parameters, DatabaseAccessAccount and DatabaseServer. All other parameters are optional.

New-SharePointFarm -DatabaseAccessAccount <PSCredential> -DatabaseServer <String> [-Passphrase <SecureString>] [-Port <Int>] [-AdminAuthMethod <NTLM | Kerberos>] [-FarmName <String>]

Example: New-SharePointFarm -DatabaseAccessAccount (Get-Credential DOMAIN\username) -DatabaseServer "SQL01" -FarmName "TestFarm"

Join-SharePointFarm

You run the Join-SharePointFarm command on servers to connect them to the farm.

The syntax for the Join-SharePointFarm command is listed below and there are two required parameters, DatabaseServer and ConfigurationDatabaseName. All other parameters are optional.

Join-SharePointFarm -DatabaseServer <String> -ConfigurationDatabaseName <String> [-Passphrase <SecureString>]

Common site collection templates

The following table describes common templates used in Install SharePoint Foundation 2010 by using Windows PowerShell.