Installing SharePoint 2010 Using PowerShell

PowerShell is a critical tool for SharePoint administrators that actually allows for options not available in the standard central administration GUI. For example, PowerShell is the only method that enables the creation of custom names for many of the databases created by SharePoint during the installation. In addition, creating a custom PowerShell script for installation of a new farm enables that farm to be repeatedly created, such as in the case of development farms.

Examining a PowerShell Script for Provisioning a Farm

When SharePoint binaries are installed in an environment, PowerShell can be used to provision any farm. The following script illustrates a way to have PowerShell create a new farm based on input from the end user and have all databases from that farm use the name of the farm in the database name, to enable multiple farms to be created in a single environment:

———————————————————-
$configType = read-host "Do you wish to join an existing Farm? (Y/N)"
if ($ConfigType -eq "Y") {
    $DatabaseServer = read-host "Preparing to join existing farm. Please specify the name of your SQL Server";
    $ConfigDB = read-host "Next, specify the name of your Farm Configuration Database";
    $Passphrase = read-host "Finally, please enter your Farm passphrase" -assecurestring
} else {
    $DatabaseServer = read-host "Preparing to create a new Farm. Please specify the name of your SQL Server";
    $FarmName = read-host "Please specify a name for your Farm (ex. SP2010Dev)";
    $ConfigDB = $FarmName+"_ConfigDB";
    $AdminContentDB = $FarmName+"_Admin_ContentDB";
    Write-Host "Please enter the credentials for your Farm Account (ex. COMPANYABC\SP_Farm)";
    $FarmAcct = Get-Credential;
    $Passphrase = read-host "Enter a secure Farm passphrase" -assecurestring;
    $Port = read-host "Enter a port number for the Central Administration Web App";
    $Authentication = read-host "Finally, specify your authentication provider (NTLM/Kerberos)";
}
if ($ConfigType -eq "Y") {
    Add-PSSnapin Microsoft.SharePoint.PowerShell;
    Connect-SPConfigurationDatabase -DatabaseName $ConfigDB -DatabaseServer $DatabaseServer -Passphrase $Passphrase
} else {
    Add-PSSnapin Microsoft.SharePoint.PowerShell;
    Write-Host "Your SharePoint Farm is being configured..."
    New-SPConfigurationDatabase -DatabaseName $ConfigDB -DatabaseServer $DatabaseServer -AdministrationContentDatabaseName $AdminContentDB -Passphrase $Passphrase -FarmCredentials $FarmAcct
}
Initialize-SPResourceSecurity
Install-SPService
Install-SPFeature -AllExistingFeatures
New-SPCentralAdministration -Port $Port -WindowsAuthProvider $Authentication
Install-SPHelpCollection -All
Install-SPApplicationContent
Write-Host "Your SharePoint 2010 Farm has been created!"
if ($ConfigType -eq "N") {
    $WebAppCreation = read-host "Would you like to provision a Web Application using the default Team Site Template? (Y/N)";
    if ($WebAppCreation -eq "Y") {
        $HostHeaderQ = read-host "Would you like to specify a host header? (Y/N)";
        if ($HostHeaderQ -eq "Y") {
            $HostHeader = read-host "Please specify a host header for your Web Application (ex. intranet.contoso.com)";
            $URL = "http://"+$HostHeader;
            Write-Host "Creating your Web Application...";
            New-SPWebApplication -Name "SharePoint 2010 Team Site" -Port 80 -HostHeader $FQDN -Url $URL -ApplicationPool "Content_AppPool" -ApplicationPoolAccount (Get-SPManagedAccount $FarmAcct.UserName) -DatabaseServer$DatabaseServer -DatabaseName $FarmName + "_TeamSite_ContentDB_01";
            New-SPSite $URL -OwnerAlias $FarmAcct.UserName -Language 1033 -Template "STS#0" -Name "Team Site";
            Write-Host "Configuration completed.";
        }
        else {
        Write-Host "Creating a Web Application using the default Team Site Template..."
        }
    }
    else {
        Write-Host "Configuration completed.";
    }
}
Write-Host "Press any key to continue..."
$x = $host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")
———————————————————

					  

Using concepts such as those demonstrated in this script, you can automate the creation of an entire custom farm and have more control over the entire farm creation process. Modifying variables and customizing the commandlets illustrated in the script can enable further customization.

PowerShell for Provisioning Service Applications

Service application provisioning is a much more complex process than the installation of a single farm. Consequently, a PowerShell script to provision all service applications in a farm can be much longer and more complex. The following script can be used to provision nearly all available SharePoint 2010 service applications, and it walks the end user through the process and enables them to choose which service applications they want to install:

———————————————————-
cls
if((Get-PSSnapin | Where {$_.Name -eq "Microsoft.SharePoint.PowerShell"}) -eq $null) {
    Add-PSSnapin Microsoft.SharePoint.PowerShell;
}

function Start-SPService($ServiceInstanceTypeName) {
    $ServiceInstance = (Get-SPServiceInstance | Where {$_.TypeName -eq $ServiceInstanceTypeName})

    if($ServiceInstance.Status -ne "Online" -and $ServiceInstance.Status -ne "Provisioning") {
        $ServiceInstance | Start-SPServiceInstance
    }

    $i = 0;
    while(-not ($ServiceInstance.Status -eq "Online") -and $i -lt 10) {
        Write-Host -ForegroundColor Yellow "Waiting for the $ServiceInstanceTypeName service to provision...";
        sleep 10;
        $ServiceInstance = (Get-SPServiceInstance | Where {$_.TypeName -eq $ServiceInstanceTypeName})

        $i += 1;

        if($i -eq 10) {
            $continue = Read-Host "Service $ServiceInstanceTypeName has not yet been provisioned. Would you like to wait? (Y/N)"

            if($continue -eq "Y") {
                $i = 0;
            }
        }
    }
}

Function Configure-SPSearch  {
    PARAM($AppPool, $FarmName, $SearchServiceAccount)

    $searchServiceInstance = Get-SPEnterpriseSearchServiceInstance -local
    Start-SPEnterpriseSearchServiceInstance -Identity $searchServiceInstance

    $dbName = $FarmName + "_SearchServiceApplication"

    $searchApplication = New-SPEnterpriseSearchServiceApplication -Name "$FarmName Search Service Application" -ApplicationPool $AppPool -DatabaseName $dbName
    $searchApplicationProxy = New-SPEnterpriseSearchServiceApplicationProxy -name "$FarmName Search Service Application Proxy" -SearchApplication $searchApplication

    Set-SPEnterpriseSearchAdministrationComponent -SearchApplication $searchApplication  -SearchServiceInstance $searchServiceInstance

    $crawlTopology = New-SPEnterpriseSearchCrawlTopology -SearchApplication $searchApplication
    $crawlDatabase = Get-SPEnterpriseSearchCrawlDatabase -SearchApplication $searchApplication

    New-SPEnterpriseSearchCrawlComponent -CrawlTopology $crawlTopology -CrawlDatabase $crawlDatabase -SearchServiceInstance $searchServiceInstance

    while($crawlTopology.State -ne "Active")
    {
        $crawlTopology | Set-SPEnterpriseSearchCrawlTopology -Active -ErrorAction SilentlyContinue
        if ($crawlTopology.State -ne "Active")
        {
            Start-Sleep -Seconds 10
        }
    }

    $queryTopology = New-SPenterpriseSEarchQueryTopology -SearchApplication $searchApplication -partitions 1
    $searchIndexPartition = Get-SPEnterpriseSearchIndexPartition -QueryTopology $queryTopology
    New-SPEnterpriseSearchQueryComponent -indexpartition $searchIndexPartition -QueryTopology $queryTopology -SearchServiceInstance $searchServiceInstance

    $propertyDB = Get-SPEnterpriseSearchPropertyDatabase -SearchApplication $searchApplication

    Set-SPEnterpriseSearchIndexPartition $searchIndexPartition -PropertyDatabase $propertyDB

    while ($queryTopology.State -ne "Active")
    {
        $queryTopology | Set-SPEnterpriseSearchQueryTopology -Active -ErrorAction SilentlyContinue

        if ($queryTopology.State -ne "Active")
        {
            Start-Sleep -Seconds 10
        }
    }
}
function Start-SPTimer {
    $spTimerService = Get-Service "SPTimerV4"

    if($spTimerService.Status -ne "Running") {
        Write-Host -ForegroundColor Yellow "SharePoint 2010 Timer Service is not running. Attempting to start the timer."
        Start-Service "SPTimerV4"
        $spTimerService = Get-Service "SPTimerV4"

        while($spTimerService.Status -ne "Running") {
            Start-Sleep -Seconds 10
            Start-Service "SPTimerV4"
            $spTimerService = Get-Service "SPTimerV4"
        }

        Write-Host -ForegroundColor Green "SharePoint 2010 Timer Service is running."
    }
    else {
        Write-Host -ForegroundColor Green "SharePoint 2010 Timer Service is running."
    }
}



Function Get-SPServiceApplicationPoolByName($SPApplicationPoolName, $ManagedAccount) {

    $appPool = Get-SPServiceApplicationPool | Where {$_.Name -eq $SPApplicationPoolName}

    if($appPool -eq $null) {
        $appPool = New-SPServiceApplicationPool -Name $SPApplicationPoolName -Account $ManagedAccount
    }

    Return $appPool
}

Function Get-SPManagedAccountByName($AccountName) {
    $managedAccount = Get-SPManagedAccount | Where {$_.Username -eq $AccountName}

    if($managedAccount -eq $null) {
        Write-Host "Please enter the credentials for your Managed Account ($AccountName)";
        $managedAccountCredential = Get-Credential;
        $managedAccount = New-SPManagedAccount $managedAccountCredential
    }

    Return $managedAccount
}

Function Get-SPServiceApplicationByType($TypeName) {
    $serviceApplications = Get-SPServiceApplication | Where  {$_.TypeName -eq $TypeName}

    if($serviceApplications -ne $null) {
        $true;
    }
    else {
        $false;
    }
}

Function New-SPStateServiceApplicationGroup($FarmName){
        $dbName = $FarmName + "_StateService"

        Write-Host -ForegroundColor Yellow "Installing State Service Application..."

        New-SPStateServiceDatabase $dbName | New-SPStateServiceApplication -Name "$FarmName State Service Application" | New-SPStateServiceApplicationProxy -Name "$FarmName State Service Application Proxy" -DefaultProxyGroup
        sleep 10;

        Write-Host -ForegroundColor Green "State Service Application installed..."
}

Function New-SPUsageApplicationAndProxy($FarmName) {
    Write-Host -ForegroundColor Yellow "Installing Usage and Health Data Collection Service..."

    $dbName = $FarmName + "_UsageandHealthDataCollectionService"
    New-SPUsageApplication "$FarmName Usage and Health Data Collection Service" -DatabaseName $dbName
    $usageApplicationProxy = Get-SPServiceApplicationProxy | where{$_.Name -eq "$FarmName Usage and Health Data Collection Service"}

    if($usageApplicationProxy.Status -eq "Disabled") {
        $usageApplicationProxy.Status = "Online";
        $usageApplicationProxy.Update();
    }
    Write-Host -ForegroundColor Green "Installing Usage and Health Data Collection Service installed."
}

Function Rename-SQLDatabase {
    param (
          [string] $ServerName,
          [string] $SourceDb,
          [string] $DestDb
)

    $connection = New-Object System.Data.SqlClient.SqlConnection
    $command = New-Object System.Data.SqlClient.SqlCommand

    $connection.ConnectionString = "Server=$ServerName;Integrated Security=True;"

    $command.CommandText = "ALTER DATABASE [$SourceDb] SET OFFLINE WITH ROLLBACK IMMEDIATE;ALTER DATABASE [$SourceDb] SET ONLINE;EXEC sp_renamedb [$SourceDb], [$DestDb];"
    $command.Connection = $connection

    $command.Connection.Open();
    $command.ExecuteNonQuery();
    $command.Connection.Close();
}

Function New-SPPerformancePointApplicationAndProxy($AppPool, $DBServer, $FarmName) {
    Write-Host -ForegroundColor Yellow "Installing PerformancePoint Service..."

    $ppApp = New-SPPerformancePointServiceApplication -Name "$FarmName PerformancePoint Services" -ApplicationPool $AppPool

    $temp = $ppApp.SettingsDatabase.split("\");
    $dbName = $temp[$temp.Length-1];

    $newDBName = $FarmName + "_PerformancePointServices"

    Rename-SQLDatabase -servername $DBServer -sourceDb $dbName -destDb $newDBName;
    Set-SPPerformancePointServiceApplication "$FarmName PerformancePoint Services" -SettingsDatabase "$DBServer\$newDBName";

    New-SPPerformancePointServiceApplicationProxy -ServiceApplication "$FarmName PerformancePoint Services" -Name "$FarmName PerformancePoint Services Proxy" -Default
    Write-Host -ForegroundColor Green "PerformancePoint Service installed."

    Start-SPService "PerformancePoint Service"
}

$serviceAppConfiguration = read-host "Would you like to configure SharePoint Service Applications? (Y/N)"
if ($serviceAppConfiguration -eq "Y") {
    # Starting SP Timer Service
    Start-SPTimer

    $appPoolName = Read-Host "Please specify a name for ServiceApp application pool (eg. ServiceAppPool)"

    $managedAccountName = Read-Host "Please enter service account (eg. CompanyABC\sp_service)"
    $managedAccount = Get-SPManagedAccountByName $managedAccountName

    $appPool = Get-SPServiceApplicationPoolByName $appPoolName $managedAccount

    #$DatabaseServer = read-host "Preparing to join existing farm. Please specify the name of your SQL Server";
    $FarmName =  Read-Host "Please enter your farm name";


    $decision = read-host "Would you like to install State Service Application? (Y/N)"
    if ($decision -eq "Y") {
        New-SPStateServiceApplicationGroup $FarmName
    }

    $decision = read-host "Would you like to install Usage and Health Data Collection Service Application? (Y/N)"
    if ($decision -eq "Y") {
        New-SPUsageApplicationAndProxy $FarmName
    }

    $decision = read-host "Would you like to install Access Services? (Y/N)"
    if ($decision -eq "Y") {
        Write-Host -ForegroundColor Yellow "Installing Access Services..."
        Start-SPService("Access Database Service")
        New-SPAccessServiceApplication -Name "$FarmName Access Services" -ApplicationPool $appPool -Default
        Write-Host -ForegroundColor Green "Access Services installed."
    }

    $decision = read-host "Would you like to install Business Data Connectivity Service? (Y/N)"
    if ($decision -eq "Y") {
        Write-Host -ForegroundColor Yellow "Installing Business Data Connectivity Service..."
        Start-SPService("Business Data Connectivity Service")

        $dbName = $FarmName + "_BusinessDataConnectivityService"

        New-SPBusinessDataCatalogServiceApplication -Name "$FarmName Business Data Connectivity Service" -ApplicationPool $appPool -databaseName $dbName

        Write-Host -ForegroundColor Green "Business Data Connectivity Service installed."
    }

    $decision = read-host "Would you like to install Search Service? (Y/N)"
    if ($decision -eq "Y") {
        Write-Host -ForegroundColor Yellow "Installing Search Service..."

        $newAccount = Read-Host "Would you like to use $managedAccountName as the search service account? (Y/N)"
        if($newAccount -eq "N") {
            $searchAccountName = Read-Host "Please enter search account (eg. CompanyABC\sp_search)"
            $searchAccount = Get-SPManagedAccountByName $searchAccountName
        }
        else {
            $searchAccount = $managedAccount
        }

        if(-not (Get-SPServiceApplicationByType("Usage and Health Data Collection Service Application"))) {
            $decision = Read-Host "Usage and Health Data Collection Service Application needs to be installed to run Search Service. Would you like to install
it now (Y/N)?"
            if ($decision -eq "Y") {
                New-SPUsageApplicationAndProxy $FarmName
            }
        }

        Configure-SPSearch $appPoolName $FarmName $searchAccount

        Write-Host -ForegroundColor Green "Search Service installed."
    }

    $decision = read-host "Would you like to install Excel Services? (Y/N)"
    if ($decision -eq "Y") {
        Write-Host -ForegroundColor Yellow "Installing Excel Services..."
        Start-SPService("Excel Calculation Services")
        New-SPExcelServiceApplication -Name "$FarmName Excel Services" -ApplicationPool $appPool -Default
        Write-Host -ForegroundColor Green "Excel Services installed."
    }

    $decision = read-host "Would you like to install Managed Metadata Service? (Y/N)"
    if ($decision -eq "Y") {
        Write-Host -ForegroundColor Yellow "Installing Managed Metadata Service..."
        Start-SPService("Managed Metadata Web Service")

        $dbName = $FarmName + "_ManagedMetadataService"

        $MetaDataServiceApp = New-SPMetadataServiceApplication -Name "$FarmName Managed Metadata Service" -ApplicationPool $appPool -DatabaseName $dbName
        $MetaDataServiceAppProxy = New-SPMetadataServiceApplicationProxy -Name "$FarmName Managed Metadata Service Proxy" -ServiceApplication $MetaDataServiceApp -DefaultProxyGroup
        Write-Host -ForegroundColor Green "Managed Metadata Service installed."
    }


    $decision = read-host "Would you like to install PerformancePoint Service? (Y/N)"
    if ($decision -eq "Y") {
        Write-Host -ForegroundColor Yellow "Installing PerformancePoint Service..."

        $dbServer = Read-Host "Please enter the name of your database server (e.g. ""SQLSERVER"" OR ""SQLSERVER\INSTANCE"")"
        New-SPPerformancePointApplicationAndProxy $appPool $dbServer $FarmName

        Write-Host -ForegroundColor Green "PerformancePoint Service installed."
    }

    $decision = read-host "Would you like to install Secure Store Service? (Y/N)"
    if ($decision -eq "Y") {
        Write-Host -ForegroundColor Yellow "Installing Secure Store Service..."
        Start-SPService("Secure Store Service")
        $dbName = $FarmName + "_SecureStore"
        $secureStoreServiceApp = New-SPSecureStoreServiceApplication -Name "$FarmName Secure Store Service Application" -ApplicationPool $appPool -DatabaseName $dbName -AuditingEnabled:$true
        New-SPSecureStoreServiceApplicationProxy -ServiceApplication $secureStoreServiceApp -Name "$FarmName Secure Store Service Application Proxy" -DefaultProxyGroup
        Write-Host -ForegroundColor Green "Secure Store Service installed."
    }

    $decision = read-host "Would you like to install Visio Graphics Service? (Y/N)"
    if ($decision -eq "Y") {
        Write-Host -ForegroundColor Yellow "Installing Visio Graphics Service..."
        Start-SPService("Visio Graphics Service")
        New-SPVisioServiceApplication -Name "$FarmName Visio Graphics Service" -ApplicationPool $appPool
        New-SPVisioServiceApplicationProxy -Name "$FarmName Visio Graphics Service Proxy" -ServiceApplication "$FarmName Visio Graphics Service"
        Write-Host -ForegroundColor Green "Visio Graphics Service installed."
    }

    $decision = read-host "Would you like to install Word Automation Services? (Y/N)"
    if ($decision -eq "Y") {
        Write-Host -ForegroundColor Yellow "Installing Word Automation Services..."
        Start-SPService("Word Automation Services")

        $dbName = $FarmName + "_WordAutomationServices"

        New-SPWordConversionServiceApplication -Name "$FarmName Word Automation Services" -ApplicationPool $appPool -DatabaseName $dbName -Default
        Write-Host -ForegroundColor Green "Word Automation Services installed."
    }

    $decision = read-host "Would you like to start Microsoft SharePoint Foundation Sandboxed Code Service? (Y/N)"
    if ($decision -eq "Y") {
        Write-Host -ForegroundColor Yellow "Configuring Microsoft SharePoint Foundation Sandboxed Code Service..."
        Start-SPService("Microsoft SharePoint Foundation Sandboxed Code Service")
        Write-Host -ForegroundColor Green "Microsoft SharePoint Foundation Sandboxed Code Service configure."
    }

    iisreset
}
    Write-Host -ForegroundColor Green "Installation completed."
———————————————————-

					  

Scripts like the ones previously displayed can be modified by administrators and customized as needed. The power of PowerShell is in this flexibility, because custom scripts can be used by administrators to build entire farms from scratch or simply perform everyday tasks.