en-US/about_SPInstall.help.txt
|
.NAME
SPInstall # Description **Type:** Common **Requires CredSSP:** No This resource is used to install the SharePoint binaries. The BinaryDir parameter should point to the path that setup.exe is located (not to setup.exe itself). The ProductKey parameter is used to inject in to the configuration file and validate the license key during the installation process. This module depends on the prerequisites already being installed, which can be done NOTE: This resource only supports SharePoint Server. SharePoint Foundation is not supported. For examples to install SharePoint Foundation using DSC, see: https://github.com/PowerShell/SharePointDsc/wiki/SPInstall (Example 3) NOTE 2: When files are downloaded from the Internet, a Zone.Identifier alternate data stream is added to indicate that the file is potentially from an unsafe source. To use these files, make sure you first unblock them using Unblock-File. SPInstall will throw an error when it detects the file is blocked. ## Multilingual support Where possible, resources in SharePointDsc have been written in a way that they should support working with multiple language packs for multilingual deployments. However due to constraints in how we set up and install the product, only English ISOs are supported for installing SharePoint. .PARAMETER IsSingleInstance Key - String Allowed values: Yes Specifies the resource is a single instance, the value must be 'Yes' .PARAMETER BinaryDir Required - String The directory that contains all of the SharePoint binaries .PARAMETER ProductKey Required - String The product key to use during the installation .PARAMETER InstallPath Write - String The install directory to use in the installation, leave blank to use the setup defaults .PARAMETER DataPath Write - String The data directory to use in the installation, leave blank to use the setup defaults .PARAMETER Ensure Write - string Allowed values: Present, Absent Present to install SharePoint. Absent is currently not supported .EXAMPLE This module will install SharePoint to the default locations. The binaries for SharePoint in this scenario are stored at C:\SPInstall (so it will look to run C:\SPInstall\Setup.exe) Configuration Example { param( [Parameter(Mandatory = $true)] [PSCredential] $SetupAccount ) Import-DscResource -ModuleName SharePointDsc node localhost { SPInstall InstallBinaries { IsSingleInstance = "Yes" BinaryDir = "C:\SPInstall" ProductKey = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" } } } .EXAMPLE This module will install SharePoint to the specific locations set for the InstallPath and DataPath directories. Configuration Example { param( [Parameter(Mandatory = $true)] [PSCredential] $SetupAccount ) Import-DscResource -ModuleName SharePointDsc node localhost { SPInstall InstallBinaries { IsSingleInstance = "Yes" BinaryDir = "D:\SharePoint\Binaries" InstallPath = "D:\SharePoint\Install" DataPath = "D:\SharePoint\Data" ProductKey = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" } } } .EXAMPLE This module will install SharePoint Foundation 2013 to the local server Configuration Example { param( [Parameter(Mandatory = $true)] [PSCredential] $SetupAccount ) Import-DscResource -ModuleName PSDesiredStateConfiguration node localhost { Package InstallSharePointFoundation { Ensure = "Present" Name = "Microsoft SharePoint Foundation 2013 Core" Path = "E:\SharePoint2013\Setup.exe" Arguments = "/config E:\SharePoint2013\files\setupfarmsilent\config.xml" ProductID = "90150000-1014-0000-1000-0000000FF1CE" ReturnCode = 0 } } } |