Scripted deployment reference (SharePoint Server 2010)
Applies to: SharePoint Server 2010, SharePoint Foundation 2010
This article describes the commands and syntax that is used in scripted deployment of a Microsoft SharePoint Server 2010 farm. It also contains a table of common templates used in Installing SharePoint Server 2010 by using Windows PowerShell.
Important
The Install-SharePoint, New-SharePointFarm, and Join-SharePointFarm commands should only be used in the context of the SPModule.zip file.
For information about using these commands to install SharePoint Server 2010, see Installing SharePoint Server 2010 by using Windows PowerShell.
In this article:
Common site collection templates
Install-SharePoint
The Install-SharePoint command installs SharePoint Server 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, a product key (PIDKey), 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, there are two required parameters, SetupExePath and PIDKey. 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:
Creates the configuration database.
Creates the administration content database.
Installs the Help collection.
Creates the Central Administration Web application.
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>]
Note
To stop the user from being prompted for the password, you can use the Passphrase parameter. The value for the Passphrase parameter is the password of the user.
Common site collection templates
The following table describes common templates used in Installing SharePoint Server 2010 by using Windows PowerShell.
Parameter value |
Description |
GLOBAL#0 |
Global template |
STS#0 |
Team Site |
STS#1 |
Blank Site |
STS#2 |
Document Workspace |
MPS#0 |
Basic Meeting Workspace |
MPS#1 |
Blank Meeting Workspace |
MPS#2 |
Decision Meeting Workspace |
MPS#3 |
Social Meeting Workspace |
MPS#4 |
Multipage Meeting Workspace |
CENTRALADMIN#0 |
Central Admin Site |
WIKI#0 |
Wiki Site |
BLOG#0 |
Blog |
SGS#0 |
Group Work Site |
TENANTADMIN#0 |
Tenant Admin Site |
ACCSRV#0 |
Access Services Site |
ACCSRV#1 |
Assets Web Database |
ACCSRV#3 |
Charitable Contributions Web Database |
ACCSRV#4 |
Contacts Web Database |
ACCSRV#6 |
Issues Web Database |
ACCSRV#5 |
Projects Web Database |
BDR#0 |
Document Center |
OFFILE#0 |
(obsolete) Records Center |
OFFILE#1 |
Records Center |
OSRV#0 |
Shared Services Administration Site |
PPSMASite#0 |
PerformancePoint |
BICenterSite#0 |
Business Intelligence Center |
PWA#0 |
Project Web App Site |
PWS#0 |
Microsoft Project Site |
SPS#0 |
SharePoint Portal Server Site |
SPSPERS#0 |
SharePoint Portal Server Personal Space |
SPSMSITE#0 |
Personalization Site |
SPSTOC#0 |
Contents area Template |
SPSTOPIC#0 |
Topic area template |
SPSNEWS#0 |
News Site |
CMSPUBLISHING#0 |
Publishing Site |
BLANKINTERNET#0 |
Publishing Site |
BLANKINTERNET#1 |
Press Releases Site |
BLANKINTERNET#2 |
Publishing Site with Workflow |
SPSNHOME#0 |
News Site |
SPSSITES#0 |
Site Directory |
SPSCOMMU#0 |
Community area template |
SPSREPORTCENTER#0 |
Report Center |
SPSPORTAL#0 |
Collaboration Portal |
SRCHCEN#0 |
Enterprise Search Center |
PROFILES#0 |
Profiles |
BLANKINTERNETCONT |
Publishing Portal |
SPSMSITEHOST#0 |
My Site Host |
ENTERWIKI#0 |
Enterprise Wiki |
SRCHCENTERLITE#0 |
Basic Search Center |
SRCHCENTERLITE#1 |
Basic Search Center |
SRCHCENTERFAST#0 |
FAST Search Center |
visprus#0 |
Visio Process Repository |