en-US/about_SPInstallPrereqs.help.txt
|
.NAME
SPInstallPrereqs # Description **Type:** Common **Requires CredSSP:** No This resource is responsible for ensuring the installation of all SharePoint prerequisites. It makes use of the PrerequisiteInstaller.exe file that is part of the SharePoint binaries, and will install the required Windows features as well as additional software. The OnlineMode boolean will tell the prerequisite installer which mode to run in, if it is online you do not need to list any other parameters for this resource. If you do not use online mode, you must include all other parameters to specify where the installation files are located. These additional parameters map directly to the options passed to prerequisiteinstaller.exe. For installations with no connectivity to Windows Update, use the SXSpath parameter to specify the path to the SXS store of your Windows Server install media. Additionally, the process of installing the prerequisites on a Windows Server usually results in 2-3 restarts of the system being required. To ensure the DSC configuration is able to restart the server when needed, ensure the below settings for the local configuration manager are included in your DSC file. LocalConfigurationManager { RebootNodeIfNeeded = $true } ## Installing from network locations If you wish to install the prerequisites from a network location this can be done, however you must disable User Account Control (UAC) on the server to allow DSC to run the executable from a remote location, and also set the PsDscRunAsCredential value to run as an account with local admin permissions as well as read access to the network location. It is *not recommended* to disable UAC for security reasons. The recommended approach is to copy the installation media to the local nodes first and then execute the installation from there. ## Downloading prerequisites The SharePoint prerequisites can be downloaded from the following locations: SharePoint 2013: https://technet.microsoft.com/library/a88d3f72-7ac3-4f08-b302-c4ca0a796268%28v=office.16%29.aspx?#section5 SharePoint 2016: https://technet.microsoft.com/en-us/library/cc262485(v=office.16).aspx#section5 SharePoint 2019: .PARAMETER IsSingleInstance Key - String Allowed values: Yes Specifies the resource is a single instance, the value must be 'Yes' .PARAMETER InstallerPath Required - String The full path to prerequisiteinstaller.exe .PARAMETER OnlineMode Required - Boolean Should the installer download prerequisites from the internet or not .PARAMETER SXSpath Write - String The path to the Windows Server Operating System SXS source files, for use in closed environments without access to Windows Update .PARAMETER SQLNCli Write - String The path to the installer for this prerequisite (SP2013 and SP2016) .PARAMETER PowerShell Write - String The path to the installer for this prerequisite (SP2013 only) .PARAMETER NETFX Write - String The path to the installer for this prerequisite (SP2013 only) .PARAMETER IDFX Write - String The path to the installer for this prerequisite (SP2013 only) .PARAMETER Sync Write - String The path to the installer for this prerequisite (SP2013 and SP2016) .PARAMETER AppFabric Write - String The path to the installer for this prerequisite (SP2013 and SP2016) .PARAMETER IDFX11 Write - String The path to the installer for this prerequisite (SP2013 and SP2016) .PARAMETER MSIPCClient Write - String The path to the installer for this prerequisite (SP2013 and SP2016) .PARAMETER WCFDataServices Write - String The path to the installer for this prerequisite (SP2013 only) .PARAMETER KB2671763 Write - String The path to the installer for this prerequisite (SP2013 only) .PARAMETER WCFDataServices56 Write - String The path to the installer for this prerequisite (SP2013 and SP2016) .PARAMETER MSVCRT11 Write - String The path to the installer for this prerequisite (SP2016 only) .PARAMETER MSVCRT14 Write - String The path to the installer for this prerequisite (SP2016 only) .PARAMETER KB3092423 Write - String The path to the installer for this prerequisite (SP2016 only) .PARAMETER ODBC Write - String The path to the installer for this prerequisite (SP2016 only) .PARAMETER DotNetFx Write - String The path to the installer for this prerequisite (SP2016 only) .PARAMETER DotNet472 Write - String The path to the installer for this prerequisite (SP2019 only) .PARAMETER MSVCRT141 Write - String The path to the installer for this prerequisite (SP2019 only) .PARAMETER Ensure Write - string Allowed values: Present, Absent Present to install the prerequisites. Absent is currently not supported .EXAMPLE This module will install the prerequisites for SharePoint. This resource will run in online mode, looking to download all prerequisites from the internet. Configuration Example { param( [Parameter(Mandatory = $true)] [PSCredential] $SetupAccount ) Import-DscResource -ModuleName SharePointDsc node localhost { SPInstallPrereqs InstallPrerequisites { IsSingleInstance = "Yes" InstallerPath = "C:\SPInstall\Prerequisiteinstaller.exe" OnlineMode = $true } } } .EXAMPLE This module will install the prerequisites for SharePoint 2013. This resource will run in offline mode, running all prerequisite installations from the specified paths. Configuration Example { param( [Parameter(Mandatory = $true)] [PSCredential] $SetupAccount ) Import-DscResource -ModuleName SharePointDsc node localhost { SPInstallPrereqs InstallPrerequisites { IsSingleInstance = "Yes" InstallerPath = "C:\SPInstall\Prerequisiteinstaller.exe" OnlineMode = $false SXSpath = "c:\SPInstall\Windows2012r2-SXS" SQLNCli = "C:\SPInstall\prerequisiteinstallerfiles\sqlncli.msi" PowerShell = "C:\SPInstall\prerequisiteinstallerfiles\Windows6.1-KB2506143-x64.msu" NETFX = "C:\SPInstall\prerequisiteinstallerfiles\dotNetFx45_Full_setup.exe" IDFX = "C:\SPInstall\prerequisiteinstallerfiles\Windows6.1-KB974405-x64.msu" Sync = "C:\SPInstall\prerequisiteinstallerfiles\Synchronization.msi" AppFabric = "C:\SPInstall\prerequisiteinstallerfiles\WindowsServerAppFabricSetup_x64.exe" IDFX11 = "C:\SPInstall\prerequisiteinstallerfiles\MicrosoftIdentityExtensions-64.msi" MSIPCClient = "C:\SPInstall\prerequisiteinstallerfiles\setup_msipc_x64.msi" WCFDataServices = "C:\SPInstall\prerequisiteinstallerfiles\WcfDataServices.exe" KB2671763 = "C:\SPInstall\prerequisiteinstallerfiles\AppFabric1.1-RTM-KB2671763-x64-ENU.exe" WCFDataServices56 = "C:\SPInstall\prerequisiteinstallerfiles\WcfDataServices56.exe" } } } .EXAMPLE This module will install the prerequisites for SharePoint 2016/2019. This resource will run in offline mode, running all prerequisite installations from the specified paths. Configuration Example { param( [Parameter(Mandatory = $true)] [PSCredential] $SetupAccount ) Import-DscResource -ModuleName SharePointDsc node localhost { SPInstallPrereqs InstallPrerequisites { IsSingleInstance = "Yes" InstallerPath = "C:\SPInstall\Prerequisiteinstaller.exe" OnlineMode = $false SXSpath = "C:\SPInstall\Windows2012r2-SXS" SQLNCli = "C:\SPInstall\prerequisiteinstallerfiles\sqlncli.msi" Sync = "C:\SPInstall\prerequisiteinstallerfiles\Synchronization.msi" AppFabric = "C:\SPInstall\prerequisiteinstallerfiles\WindowsServerAppFabricSetup_x64.exe" IDFX11 = "C:\SPInstall\prerequisiteinstallerfiles\MicrosoftIdentityExtensions-64.msi" MSIPCClient = "C:\SPInstall\prerequisiteinstallerfiles\setup_msipc_x64.msi" WCFDataServices56 = "C:\SPInstall\prerequisiteinstallerfiles\WcfDataServices56.exe" MSVCRT11 = "C:\SPInstall\prerequisiteinstallerfiles\vcredist_x64.exe" MSVCRT14 = "C:\SPInstall\prerequisiteinstallerfiles\vc_redist.x64.exe" KB3092423 = "C:\SPInstall\prerequisiteinstallerfiles\AppFabric-KB3092423-x64-ENU.exe" ODBC = "C:\SPInstall\prerequisiteinstallerfiles\msodbcsql.msi" DotNetFx = "C:\SPInstall\prerequisiteinstallerfiles\NDP46-KB3045557-x86-x64-AllOS-ENU.exe" } } } |